Explorar el Código

Update README.md

Matt Coles hace 10 años
padre
commit
61c67cf695
Se han modificado 1 ficheros con 5 adiciones y 5 borrados
  1. 5 5
      README.md

+ 5 - 5
README.md

@@ -46,8 +46,8 @@ In order to register a new user account, a `POST` request should be sent, with
46 46
 the following data:
47 47
 ```javascript
48 48
 {
49
-    "user": desired_username_here,
50
-    "password": desired_password_here
49
+    "user": "FooBar", // Desired username goes here
50
+    "password": "hunter2" // Desired password goes here
51 51
 }
52 52
 ```
53 53
 The server will then respond with a JSON object that looks something like this:
@@ -65,9 +65,9 @@ In order to log into an account, or essentially request a new authentication
65 65
 token, a `POST` request should be sent with the following data:
66 66
 ```javascript
67 67
 {
68
-    "user": username_here,
69
-    "password": password_here, // Optional field if auth-key is present
70
-    "auth-key": auth_key_here // Optional field if password is present
68
+    "user": "FooBar", // Username goes here
69
+    "password": "hunter2", // Optional field if auth-key is present
70
+    "auth-key": "$2a$10$.X9YrNyd2R7b2ycAumHn.ONiINs2bCkRDupugu6sjZkUkPmXSaSra" // Optional field if password is present
71 71
 }
72 72
 ```
73 73
 Using the auth-key will reset and generate a new authentication key, whereas