shishantbiswas/aniwatch-api
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: updated Development & Documentation sections

Browse Source
This commit is contained in:
Ritesh Ghosh
2023-08-06 18:56:03 +05:30
parent 0d5f8121ee
commit 666bb72158
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -2
View File
@@ -64,6 +64,11 @@
- Installation - Installation
- Local Installation - Local Installation
- Documentation - 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 - Development
- Support - Support
- License - License
@@ -315,7 +320,7 @@ console.log(data);
| Parameter | Type | Description | Required? | Default | | 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` | | page | number | The page number of the result. | No | `1` |
#### Request sample #### Request sample
@@ -504,7 +509,7 @@ console.log(data);
## <span id="development">👨‍💻 Development</span> ## <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> ## <span id="support">🙌 Support</span>