aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRitesh Ghosh <[email protected]>2023-08-06 18:56:03 +0530
committerRitesh Ghosh <[email protected]>2023-08-06 18:56:03 +0530
commit666bb721588bf538747fb94d0c02512f3bf58895 (patch)
treec91e84d1675fa34dcb8dec78e1f449c820aab67a
parent0d5f8121ee97c4e400a1101570473ec5692b3bc9 (diff)
downloadaniwatch-api-666bb721588bf538747fb94d0c02512f3bf58895.tar.xz
aniwatch-api-666bb721588bf538747fb94d0c02512f3bf58895.zip
docs: updated `Development` & `Documentation` sections
-rw-r--r--README.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/README.md b/README.md
index ea34ea0..ebed465 100644
--- a/README.md
+++ b/README.md
@@ -64,6 +64,11 @@
- Installation
- Local Installation
- Documentation
+ - [GET Anime Home Page](#get-anime-home-page)
+ - [GET Anime About Info](#get-anime-about-info)
+ - [GET Search Results](#get-search-results)
+ - [GET Genre Animes](#get-genre-animes)
+ - [GET Category Anime](#get-category-anime)
- Development
- Support
- License
@@ -315,7 +320,7 @@ console.log(data);
| Parameter | Type | Description | Required? | Default |
| :-------: | :----: | :---------------------------------------------------------------: | :-------: | :-----: |
-| query | string | The search query, i.e. the title of the item you are looking for. | Yes | -- |
+| q | string | The search query, i.e. the title of the item you are looking for. | Yes | -- |
| page | number | The page number of the result. | No | `1` |
#### Request sample
@@ -504,7 +509,7 @@ console.log(data);
## <span id="development">👨‍💻 Development</span>
-Stars and pull requests are almost always welcome. If you encounter any bug or want to add a new feature to this api, consider creating a new [issue](https://github.com/ghoshRitesh12/zoro.to-api/issues). If you wish to contribute to this project, read the [CONTRIBUTING.md](https://github.com/ghoshRitesh12/zoro.to-api/blob/main/CONTRIBUTING.md) file.
+Pull requests and stars are always welcome. If you encounter any bug or want to add a new feature to this api, consider creating a new [issue](https://github.com/ghoshRitesh12/zoro.to-api/issues). If you wish to contribute to this project, read the [CONTRIBUTING.md](https://github.com/ghoshRitesh12/zoro.to-api/blob/main/CONTRIBUTING.md) file.
## <span id="support">🙌 Support</span>