From fb2d665c3972461ee26b900a23f406c51f6d892c Mon Sep 17 00:00:00 2001 From: ThanosApollo Date: Sat, 6 Aug 2022 14:54:04 +0300 Subject: [PATCH] Update README, add usage,ToC and fix hyperlinks --- README.md | 43 +++++++++++++++++++++++++++++++++---------- 1 file changed, 33 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1855c15..9a6e1be 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,39 @@ -

PokeTube Source Repo - GitHub

+ +# PokeTube Source Repo - GitHub - this is the source code of PokeTube! (whoa) the youtube front-end that doesnt tracks you ^^ - - for matomos source code,see here. - - to self host you'll need [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. when you do,simpliy download the repo and run "node server.js" or npm start in the terminal. btw you probably need alot of ram to host this :P ( i recommend like 8 gigs free ) - +## Table of contents +[About](#about) +[Usage](#usage) +[Why Poketube](#why-poketube) +[Legal](#legal) + + +## About +- This is the source code of PokeTube! (whoa) the youtube front-end that doesnt tracks you + - For matomos source code,see [here](https://github.com/poketube-org/poketube/tree/main/t) -## Why PokeTube? +## Usage +- To self host you'll need [Node.js](https://nodejs.org/en/download/) + - which comes with [npm](http://npmjs.com) installed on your computer + - for Arch Linux [AUR package](https://aur.archlinux.org/packages/nodejs-git) +- First clone poketube +``` +git clone https://github.com/poketube-org/poketube +``` +- Run the following command inside poketube/ +``` +npm install server +``` +- Now run +``` +node server.js +``` +- Poketube is running on `localhost:3000` +## Why PokeTube - Lyrics for songs! - Beautiful UI (Dont expect much tho lol) - No cookies,no data collection @@ -24,6 +46,7 @@ - Uses LightTube api - Custom sdk! -## Legal Stuff +## Legal -Privacy Policy: https://poketube.fun/privacy (TL;DR:we dont collect or share your personal info lol) +[Privacy Policy](https://poketube.fun/privacy) + - TL;DR:we dont collect or share your personal info lol