Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Edu authored Aug 29, 2017
1 parent 5d33a54 commit 097b61b
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,19 @@ There are two configuration files located in the `/config` folder:

## Api Reference

The `/src/routes` folder contains the API route implementations. By default each route returns a JSON response but it is possible to overwrite them in order to use XML, HTML templates (EJS, Handlebars, ...) or whatever you like.

### User

User management API.

- /users/login
- /users/logout
- /users/register

### Links

A user session is necessary in order to interact with The Links API.
Link management API. A valied session is necessary in order to interact with The Links API (see User API).

- /links/
- /links/new
Expand All @@ -59,5 +63,4 @@ A user session is necessary in order to interact with The Links API.
* Add tests
* Add more logging and logging options
* Migrate logging to winston
* Add model validation
* Refactor callback hell functions to async/await
* Do some refactor

0 comments on commit 097b61b

Please sign in to comment.