1 files changed, 14 insertions(+), 0 deletions(-)

M README.md

@@ 70,6 70,20 @@ Returning:
 
 ## Endpoints
 
+The API consists of the following endpoints:
+
+- `POST /auth/register(/)`: register a user
+- `POST /auth/login(/)`: log in with a username and password 
+- `GET /users(/)`: \* list users
+- `POST /users(/)`: \* register a new user (redundant, to be removed)
+- `GET /users/<user-id>(/)`: \* view a user profile
+- `DELETE /users/<user-id>(/)`: \* delete user profile (only if the
+  profile is your own)
+- `PUT /auth/register(/)`: \* update user profile (only if the profile
+  is your own)
+
+\* Request requires authentication via JWT.
+
 ## Tests
 
 To run the test suite, run via _npm_, `npm t`.