From c52153c3c36c57b41c55e32f7ac369f73e019b3b Mon Sep 17 00:00:00 2001 From: Shiny Nematoda Date: Sun, 26 Mar 2023 17:08:12 +0000 Subject: [PATCH] Update docs & year in license [CI SKIP] --- README.md | 45 ++++++++++++++++++++++++++++++++++++--------- 1 file changed, 36 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c2d3337..6ffbf6c 100644 --- a/README.md +++ b/README.md @@ -4,24 +4,51 @@ Until NewPipeExtractor Supports Youtube Music Browse endpoints. ## Self-Hosting +*Please see [Hyperpipe/Docker](https://codeberg.org/Hyperpipe/Docker) if hosting both the frontend and the backend* + ### Docker -Configure using `docker-compose.yml` ( Set the Proxy URL ) - -Then run - -`# docker-compose up -d` - +Run the [container](https://codeberg.org/Hyperpipe/-/packages/container/hyperpipe-backend/latest) with `HYP_PROXY` set as an env var ## Official Frontend -https://codeberg.org/Hyperpipe/hyperpipe +https://codeberg.org/Hyperpipe/Hyperpipe + +## Docs + +### `GET` `/explore` + +### `GET` `/genres` + +### `GET` `/genres/:id` + +- `:id` -> `ggMPO*` + +### `GET` `/charts?params=${id}&code=${code}` + +### `GET` `/next/:id` + +- `:id` -> `song id (same as /watch?v=:id)` + +### `GET` `/lyrics/:id` + +- `:id` -> `MPLY*` + +### `GET` `/channel/:id` +s +- `:id` -> `UC*` + +### `GET` `/next/channel/:id/:params?ct=${click}&v=${visit}` + +*Use with caution* + +- `:id` -> `UC*` ## License Hyperpipe-Backend -Copyright (C) 2022 Shiny Nematoda +Copyright (C) 2022-23 Shiny Nematoda This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as @@ -34,4 +61,4 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License -along with this program. If not, see . \ No newline at end of file +along with this program. If not, see .