Skip to content

Improved docs #8

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

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

Improved docs #8

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
6 changes: 3 additions & 3 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The response JSON Object looks something like this -

Each response object has the following keys -

1. **success** - true indicates the api ran successfully. Upon error the success value is false and the object includes an errorMessage key with the error message.
1. **Success** - true indicates the api ran successfully. Upon error the success value is false and the object includes an errorMessage key with the error message.

```JSON
{
Expand All @@ -80,9 +80,9 @@ Each response object has the following keys -
}
```

2. **category** - the category you requested for.
2. **Category** - the category you requested for.

3. **data** - An array of objects each containing a news item for the category. Each object contains
3. **Data** - An array of objects each containing a news item for the category. Each object contains
* title
* content
* author
Expand Down