Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Various general improvements to README.md #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Various general improvements to README.md #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Atheist quotes API
Because I'm an Atheist. Just a ridiculously simple Node server.
Because I'm an atheist, and this is a very simple Node server.

## Production host
[https://atheists.herokuapp.com/v1/quotes](https://atheists.herokuapp.com/v1/quotes)
Expand All @@ -9,22 +9,23 @@ The `Access-Control-Allow-Origin` header is set to `*` so that you can make requ
## APIs

### `GET /v1/quotes`
Returns an array with one quote:
Returns an array containing one quotation:
```
[
"The way to see by faith is to shut the eye of reason - Benjamin Franklin"
]
```

### `GET /v1/quotes/<count>`
Returns an array with `<count>` quotes e.g. `GET /quotes/2`
Returns an array containing `<count>` quotations (e.g., `GET /quotes/2`)
```
[
"The way to see by faith is to shut the eye of reason - Benjamin Franklin",
"I'd take the awe of understanding over the awe of ignorance any day. ― Douglas Adams"
"The way to see by faith is to shut the eye of reason. -- Benjamin Franklin",
"I'd take the awe of understanding over the awe of ignorance any day. -- Douglas Adams"
]
```

### Todos
### To-do items

- Make it better...keep adding and spread the knowledge
- add more quotations
- spread the knowledge