From 028064ea5d891cbd8eb0201456f94b986020377d Mon Sep 17 00:00:00 2001 From: Ritesh Ghosh Date: Sat, 19 Aug 2023 23:45:52 +0530 Subject: [PATCH] style: linting change --- README.md | 26 ++++++++++++++------------ 1 file 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 :4000`. You can also add the `-d` flag to run the container in detached mode. ## 📚 Documentation -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