aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRitesh Ghosh <[email protected]>2023-08-19 23:45:52 +0530
committerRitesh Ghosh <[email protected]>2023-08-19 23:45:52 +0530
commit028064ea5d891cbd8eb0201456f94b986020377d (patch)
treeb080cce07948c791f085958f860f0904ca579113
parent471c02bf3dd6395c21382be37c3136717a74d9da (diff)
downloadaniwatch-api-028064ea5d891cbd8eb0201456f94b986020377d.tar.xz
aniwatch-api-028064ea5d891cbd8eb0201456f94b986020377d.zip
style: linting change
-rw-r--r--README.md26
1 files changed, 14 insertions, 12 deletions
diff --git a/README.md b/README.md
index 3c0e337..74cc079 100644
--- a/README.md
+++ b/README.md
@@ -115,23 +115,25 @@
```
Now the server should be running on [http://localhost:4000](http://localhost:4000)
-
+
### Docker
Docker image is available at [GitHub Container Registry](https://github.com/ghoshRitesh12/aniwatch-api/pkgs/container/aniwatch).
-Run the following command to pull and run the docker image.
- ```bash
- docker pull ghcr.io/ghoshritesh12/aniwatch
- docker run -p 4000:4000 ghcr.io/ghoshritesh12/aniwatch
- ```
+Run the following commands to pull and run the docker image.
+
+```bash
+docker pull ghcr.io/ghoshritesh12/aniwatch
+docker run -p 4000:4000 ghcr.io/ghoshritesh12/aniwatch
+```
+
The above command will start the server on port 4000. You can access the server at [http://localhost:4000](http://localhost:4000) and you can also change the port by changing the `-p` option to `-p <port>:4000`.
You can also add the `-d` flag to run the container in detached mode.
## <span id="documentation">📚 Documentation</span>
-The endpoints exposed by the api are listed below with examples that uses the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API), but you can use any http library.
+The endpoints exposed by the api are listed below with examples that uses the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API), but you can use any http library.
### `GET` Anime Home Page
@@ -724,11 +726,11 @@ http://localhost:4000/anime/episode-srcs?id={episodeId}&server={server}&category
#### Query Parameters
-| Parameter | Type | Description | Required? | Default |
-| :---------: | :----: | :-------------------------------------------: | :-------: | :------------: |
-| `id` | string | The id of the episode. | Yes | -- |
-| `server` | string | The name of the server. | No | `"vidstreaming"` |
-| `category` | string | The category of the episode ('sub' or 'dub'). | No | `"sub"` |
+| Parameter | Type | Description | Required? | Default |
+| :--------: | :----: | :-------------------------------------------: | :-------: | :--------------: |
+| `id` | string | The id of the episode. | Yes | -- |
+| `server` | string | The name of the server. | No | `"vidstreaming"` |
+| `category` | string | The category of the episode ('sub' or 'dub'). | No | `"sub"` |
#### Request sample