From 42cad1e409727ae8e1fd9f9d1c0b520e9c0565f8 Mon Sep 17 00:00:00 2001
From: Yigit Sever
Date: Tue, 13 Apr 2021 04:05:11 +0300
Subject: Update todo and readme

---
 README.md | 17 +++++++----------
 1 file changed, 7 insertions(+), 10 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index ff951b1..da95cce 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,22 @@
 # Gradecoin
 
-This will sit behind nginx reverse proxy so running at 127.0.0.1:8080 is no problem, or https.
+This will sit behind nginx reverse proxy so running at 127.0.0.1:8080 or not using https is not a problem.
 
 ```
-$ cargo run
-
-$ curl --location --request POST 'localhost:8080/transaction' --header 'Content-Type: application/json' --data-raw '{
-  "source": "Myself Truly",
-  "target": "Literally Anybody Else",
-  "amount": 12,
-  "timestamp": "2021-04-07T00:17:00"
-}'
+# Test the project
+$ cargo test
+
+# Read the documentation
+$ cargo doc --open
 ```
 
 # how?
-
 ## authentication
 > Uses /register endpoint
 - Student creates their own 2048 bit RSA `keypair`
 - Downloads Gradecoin's Public Key from Moodle
 - Encrypts their JSON wrapped Public Key and Student ID using Gradecoin's Public Key
+- Sends that to the /register endpoint with a POST request
 - Their public key is now in our database and can be used to sign their JWT's during requests
 
 ## transactions
-- 
cgit v1.2.3-70-g09d2