diff --git a/README.md b/README.md index 831a5591..61b9c393 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,38 @@ -# piped +# Piped [![Matrix](https://img.shields.io/matrix/piped:matrix.org)](https://matrix.to/#/#piped:matrix.org) ![Netlify](https://img.shields.io/netlify/6ccde6a7-6792-4105-9a28-ee13ce1fbc44) [![GitHub Repo stars](https://img.shields.io/github/stars/TeamPiped/Piped-Frontend?style=social)](https://github.com/TeamPiped/Piped/stargazers) [![GitHub last commit](https://img.shields.io/github/last-commit/TeamPiped/Piped-Frontend)](https://github.com/TeamPiped/Piped/commits) -## Project setup +An alternative YouTube frontend which is efficient by design. + +## Features: + +- [x] No Ads +- [x] No Tracking +- [x] Infinite Scrolling +- [x] Intergration with SponsorBlock +- [x] Intergration with LBRY +- [x] 4K support +- [x] No connections to Google's servers +- [x] Playing just audio +- [x] PWA support +- [x] Preferences saved locally +- [x] Multi-region loadbalancing +- [x] Performant by design, designed to handle 1000s of users concurrently + +## WIP + +- [ ] Proper video support Blocked by NPE[#461](https://github.com/TeamNewPipe/NewPipeExtractor/issues/461) +- [ ] Login +- [ ] Comments +- [ ] Feeds +- [ ] 8K support +- [ ] Custom extractor for streams? +- [ ] Video Muxing + +## Development Setup ``` npm install @@ -17,18 +44,4 @@ npm install npm run serve ``` -### Compiles and minifies for production - -``` -npm run build -``` - -### Lints and fixes files - -``` -npm run lint -``` - -### Customize configuration - -See [Configuration Reference](https://cli.vuejs.org/config/). +You can now make changes and see them as soon you save the file!