mirror of
https://codeberg.org/ashley/poke.git
synced 2024-11-23 16:28:11 +01:00
Update README.md
This commit is contained in:
parent
19f43779b1
commit
7e98929101
1 changed files with 15 additions and 27 deletions
38
README.md
38
README.md
|
@ -6,7 +6,7 @@
|
||||||
<img src="https://static.fsf.org/dbd/label/DRM-free%20label%20120.en.png"
|
<img src="https://static.fsf.org/dbd/label/DRM-free%20label%20120.en.png"
|
||||||
alt="DRM Free" width="65" height="65" border="0" align="middle" />
|
alt="DRM Free" width="65" height="65" border="0" align="middle" />
|
||||||
</a>
|
</a>
|
||||||
<p>PRIVACY APP OF YOUR DREAMS! :3</p>
|
<p>THE PRIVACY APP OF YOUR DREAMS! :3</p>
|
||||||
</h1>
|
</h1>
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
@ -16,12 +16,9 @@
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<a href="#welcome">Welcome!</a> | <a href="#features">Features</a> | <a href="#no-non-free-codec-needed">No Non-Free Codec</a> | <a href="#hosting-poke">Hosting</a> | <a href="#poke-community">Community</a> | <a href="#legal">Legal</a>
|
<a href="#welcome">Welcome!</a> | <a href="#features">Features</a> | <a href="#no-non-free-codec-needed">No Non-Free Codec</a> | <a href="#hosting-poke">Hosting</a> | <a href="#poke-community">Community</a> | <a href="#legal">Legal</a>
|
||||||
<br><br>
|
<br><br>
|
||||||
<a href="https://status.poketube.fun" target="_blank">
|
|
||||||
<img width="170" src="https://api.netweak.com/status-badges/K2LY9" alt="Status Badge"/>
|
|
||||||
</a>
|
|
||||||
<img src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg" alt="Stand with Ukraine">
|
<img src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg" alt="Stand with Ukraine">
|
||||||
<a href="./LICENSE">
|
<a href="./LICENSE">
|
||||||
<img src="https://img.shields.io/badge/License-GPL--3-FF6666" alt="GPL-3 License">
|
<img src="https://img.shields.io/badge/License-GPL--3-FF6666" alt="GPL-3-or-later License">
|
||||||
</a>
|
</a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -29,7 +26,7 @@
|
||||||
|
|
||||||
## Welcome!
|
## Welcome!
|
||||||
|
|
||||||
Welcome to Poke (formerly PokeTube), the privacy-friendly YouTube front-end built with the InnerTube API! Imagine paying for YouTube Premium just to download videos - couldn't be us (literally).
|
Welcome to Poke (formerly PokeTube), the privacy-friendly YouTube front-end built with the invidious API! Imagine paying for YouTube Premium just to download videos - couldn't be us (literally).
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
@ -48,14 +45,16 @@ Poke uses OpenH264, which is free software! No non-free components included :3 V
|
||||||
### NodeJS
|
### NodeJS
|
||||||
|
|
||||||
1. **Install Packages**
|
1. **Install Packages**
|
||||||
- Fedora/RHEL: `$ sudo dnf install git make gcc libcurl nodejs python libcurl4 g++`
|
- Fedora/RHEL GNU/linux: `$ sudo dnf install git make gcc libcurl nodejs python libcurl4 g++`
|
||||||
- Debian/Ubuntu: `$ sudo apt install git make gcc libcurl4-openssl-dev nodejs npm python g++`
|
- Debian/Ubuntu GNU/linux: `$ sudo apt install git make gcc libcurl4-openssl-dev nodejs npm python g++`
|
||||||
|
|
||||||
|
(we dont know if it works on non-gnu systems)
|
||||||
|
|
||||||
2. **Clone Repo**
|
2. **Clone Repo**
|
||||||
- Codeberg: `$ git clone https://codeberg.org/ashley/poke.git`
|
- Codeberg: `$ git clone https://codeberg.org/ashley/poke.git`
|
||||||
- GitHub: `$ git clone https://github.com/ashley0143/poke.git`
|
- GitHub: `$ git clone https://github.com/ashley0143/poke.git`
|
||||||
|
|
||||||
unoffical mirrors:
|
reccomended unoffical mirrors:
|
||||||
- code.lgbt: `$ git clone https://code.lgbt/mirror/poke.git` [sync every 10mins]
|
- code.lgbt: `$ git clone https://code.lgbt/mirror/poke.git` [sync every 10mins]
|
||||||
- git.lgbt: `$ git clone https://git.lgbt/mirror/poke.git` [sync every 10mins]
|
- git.lgbt: `$ git clone https://git.lgbt/mirror/poke.git` [sync every 10mins]
|
||||||
- nin0git :`$ git clone https://git.nin0.dev/mirrors/poke.git` [sync every 10mins]
|
- nin0git :`$ git clone https://git.nin0.dev/mirrors/poke.git` [sync every 10mins]
|
||||||
|
@ -70,32 +69,21 @@ Poke uses OpenH264, which is free software! No non-free components included :3 V
|
||||||
4. **Start Server**
|
4. **Start Server**
|
||||||
- `$ node server.js`
|
- `$ node server.js`
|
||||||
|
|
||||||
Congrats! PokeTube should now be running on `localhost:6003`! 🎉
|
Congrats! Poke should now be running on `localhost:6003`! 🎉
|
||||||
|
|
||||||
### Docker
|
|
||||||
|
|
||||||
1. **Create Directory**
|
|
||||||
- `$ mkdir poketube && cd poketube`
|
|
||||||
|
|
||||||
2. **Download Config**
|
|
||||||
- `$ curl -O https://codeberg.org/Ashley/poke/raw/branch/main/docker-compose.yml`
|
|
||||||
|
|
||||||
3. **Run Poke**
|
|
||||||
- `$ docker compose up -d`
|
|
||||||
|
|
||||||
Congrats! PokeTube should now be running on `localhost:6003`! 🎉
|
|
||||||
|
|
||||||
## Poke Community
|
## Poke Community
|
||||||
|
|
||||||
Join us on [Discord](https://discord.poketube.fun/) or [Matrix](https://matrix.to/#/#poke:vern.cc)! I promise we're cool! <3
|
Join us on [Discord](https://discord.poketube.fun/) or [Matrix](https://matrix.to/#/#poke:vern.cc)! I promise we're cool! <3
|
||||||
|
|
||||||
|
or if u like fedi, we host [PokeSocial](https://social.poketube.fun) as well :3
|
||||||
|
|
||||||
## The Legal Stuff (boring tbh)
|
## The Legal Stuff (boring tbh)
|
||||||
the main parts of the project is Under GPL-3.0-OR-LATER :3
|
the main parts of the project is Under GPL-3.0-OR-LATER :3
|
||||||
|
|
||||||
see the each sections LICENSE tho!!
|
see the each sections LICENSE tho!!
|
||||||
Copyleft 2021-202x Poke Project
|
|
||||||
|
Copyleft 2021-202x Poke Project, mostly ashley0143 - poke does not support the ["source first"](https://sourcefirst.com/) or ["open source"](https://opensource.org) movement :3 - we support the free software movement (fsf.org)
|
||||||
|
|
||||||
|
|
||||||
[Code Of conduct](https://codeberg.org/Ashley/poke/src/branch/main/CODE_OF_CONDUCT.md)
|
[Code Of conduct](https://codeberg.org/Ashley/poke/src/branch/main/CODE_OF_CONDUCT.md)
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue