mirror/poke
1
0
Fork 0
mirror of https://codeberg.org/ashley/poke.git synced 2024-11-22 11:57:48 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: update readme

Browse source
This commit is contained in:
oomfie 2023-08-05 00:28:25 +03:00
parent 194764ba03
commit be0926c5ec
1 changed files with 32 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
README.md
View file

@ -1,29 +1,25 @@
<a href="https://fsf.org"> <h1 align="center">
<img src="https://www.thinkpenguin.com/files/RYF.png" width="67" align="right" >
</a>
<div align="center">
<a href="https://poketube.fun/watch?v=9sJUDx7iEJw&quality=medium&=sjohgteojgytrueugtye4jhtytjrjnyıı"> <a href="https://poketube.fun/watch?v=9sJUDx7iEJw&quality=medium&=sjohgteojgytrueugtye4jhtytjrjnyıı">
<img src="https://poketube.fun/css/logo.svg" width="500"> </a><br> <img src="https://poketube.fun/css/logo.svg" width="400">
<img src='https://raw.githubusercontent.com/squiresgrant/personal-site/main/badges/firefox4.gif'> </a>
<div align=center> <a href="https://tosdr.org/en/service/7114"> </h1>
<div align="center">
[Welcome!](#welcome)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[No None-free codec needed](#no-non-free-codec-needed-3)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[Hosting Poketube~](#hosting-poketube)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[PokeTube community!](#poketube-community)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[The Legal Stuff (boring tbh)](#the-legal-stuff-boring-tbh)
<a href="https://tosdr.org/en/service/7114">
<img src="https://shields.tosdr.org/en_7114.svg"/> <img src="https://shields.tosdr.org/en_7114.svg"/>
</a><img src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg"></div> </a>
<img src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg">
<a href="./LICENSE"><img src="https://img.shields.io/badge/License-GPL--3-FF6666" alt="License - GPL-3"></a>
</div> </div>
## Wats in dis readme uwu?:
- [Welcome!](#Welcome!)
- [No Non-free codec needed :3](#no-non-free-codec-needed-3)
- [Hosting Poketube~](#hosting-poketube)
- [PokeTube Offical Communitys](#poketube-community)
- [The Legal Stuff](#the-legal-stuff)
## Welcome! ## Welcome!
This is the source code of PokeTube, the privacy-friendly youtube front-end built with the InnerTube API ([Docs](https://docs.poketube.fun)) that's packed with some pretty cool stuff including: This is the source code of PokeTube, the privacy-friendly youtube front-end built with the InnerTube API ([Docs](https://docs.poketube.fun)) that's packed with some pretty cool stuff including:
- ZERO ads - ZERO ads
- Lyrics to songs - Lyrics to songs
- A clean and modern UI - A clean and modern UI
@ -32,6 +28,7 @@ This is the source code of PokeTube, the privacy-friendly youtube front-end buil
- And built-in dislike counts Thaks to the [Return YouTube Dislike Api](https://www.returnyoutubedislike.com/)! - And built-in dislike counts Thaks to the [Return YouTube Dislike Api](https://www.returnyoutubedislike.com/)!
## No Non-free codec needed :3 ## No Non-free codec needed :3
PokeTube uses openh264 which is free software! poketube does not inculude non free stuff owowowoow!!!! PokeTube uses openh264 which is free software! poketube does not inculude non free stuff owowowoow!!!!
you can view the source code of the openh264 codec in this repo :3 --> https://github.com/cisco/openh264.git you can view the source code of the openh264 codec in this repo :3 --> https://github.com/cisco/openh264.git
@ -39,46 +36,48 @@ you can view the source code of the openh264 codec in this repo :3 --> https://g
PLEASE NOTE THAT THIS SOFTWARE MAY INCULUDE CODECS THAT IN CERTAIN COUNTRIES MAY BE COVERED BY PATENTS OR HAVE LEGAL ISSUES. PATENT AND COPYRIGHT LAWS OPERATE DIFFERENTLY DEPENDING ON WHICH COUNTRY YOU ARE IN. PLEASE OBTAIN LEGAL ADVICE IF YOU ARE UNSURE WHETHER A PARTICULAR PATENT OR RESTRICTION APPLIES TO A CODEC YOU WISH TO USE IN YOUR COUNTRY. PLEASE NOTE THAT THIS SOFTWARE MAY INCULUDE CODECS THAT IN CERTAIN COUNTRIES MAY BE COVERED BY PATENTS OR HAVE LEGAL ISSUES. PATENT AND COPYRIGHT LAWS OPERATE DIFFERENTLY DEPENDING ON WHICH COUNTRY YOU ARE IN. PLEASE OBTAIN LEGAL ADVICE IF YOU ARE UNSURE WHETHER A PARTICULAR PATENT OR RESTRICTION APPLIES TO A CODEC YOU WISH TO USE IN YOUR COUNTRY.
## Hosting Poketube~ ## Hosting Poketube~
- To self host your own Poketube instance, you'll need the following: - To self host your own Poketube instance, you'll need the following:
- [Node.js](https://nodejs.org/en/download/) - [Node.js](https://nodejs.org/en/download/)
- [npm](http://npmjs.com) (Included with Node.js) - [npm](http://npmjs.com) (Included with Node.js)
Once you have everything, clone our repo: Once you have everything, clone our repo:
``` ```
git clone https://codeberg.org/ashley/poketube.git git clone https://codeberg.org/ashley/poketube.git
``` ```
You can also clone using our Github mirror if you'd prefer: You can also clone using our Github mirror if you'd prefer:
``` ```
git clone https://github.com/ashley0143/poketube.git git clone https://github.com/ashley0143/poketube.git
``` ```
Now, install the needed dependencies within the Poketube folder: Now, install the needed dependencies within the Poketube folder:
``` ```
npm install npm install
``` ```
Once everythings installed, start your server with the following command: Once everythings installed, start your server with the following command:
``` ```
node server.js node server.js
``` ```
Congrats, Poketube should now be running on `localhost:3000`! Congrats, Poketube should now be running on `localhost:3000`!
## PokeTube community! ## PokeTube community!
Offical poketube community servers :3
[Revolt](https://rvlt.gg/poketube) <br> Join the community on [revolt](https://rvlt.gg/poketube) :3
[Discord](https://discord.gg/a3JFtTHUnp) (requires nonfree js - see stallman.org/discord.html )
## The Legal Stuff (boring tbh) ## The Legal Stuff (boring tbh)
[Code Of conduct](https://codeberg.org/Ashley/poketube/src/branch/main/CODE_OF_CONDUCT.md) <br>
[Privacy Policy](https://poketube.fun/privacy) <br>
TL;DR: we dont collect or share your personal info, that's it lol
[Code Of conduct](https://codeberg.org/Ashley/poketube/src/branch/main/CODE_OF_CONDUCT.md)
We additionally use the GNU Coding Standard, see https://www.gnu.org/prep/standards [Privacy Policy](https://poketube.fun/privacy)
<a href="https://codeberg.org/Ashley/poketube/src/branch/main/LICENSE"> <img src="https://www.gnu.org/graphics/gplv3-88x31.png"> </a> TL;DR: we dont collect or share your personal info, that's it lol.
#
We additionally use the GNU Coding Standard, see [this link.](https://www.gnu.org/prep/standards)