mirror of
				https://github.com/TeamPiped/Piped.git
				synced 2024-08-14 23:57:27 +00:00 
			
		
		
		
	readme: add initial features
This commit is contained in:
		
							parent
							
								
									241d827752
								
							
						
					
					
						commit
						1e8f5108fc
					
				
					 1 changed files with 30 additions and 17 deletions
				
			
		
							
								
								
									
										47
									
								
								README.md
									
										
									
									
									
								
							
							
						
						
									
										47
									
								
								README.md
									
										
									
									
									
								
							| 
						 | 
					@ -1,11 +1,38 @@
 | 
				
			||||||
# piped
 | 
					# Piped
 | 
				
			||||||
 | 
					
 | 
				
			||||||
[](https://matrix.to/#/#piped:matrix.org)
 | 
					[](https://matrix.to/#/#piped:matrix.org)
 | 
				
			||||||

 | 
					
 | 
				
			||||||
[](https://github.com/TeamPiped/Piped/stargazers)
 | 
					[](https://github.com/TeamPiped/Piped/stargazers)
 | 
				
			||||||
[](https://github.com/TeamPiped/Piped/commits)
 | 
					[](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
 | 
					npm install
 | 
				
			||||||
| 
						 | 
					@ -17,18 +44,4 @@ npm install
 | 
				
			||||||
npm run serve
 | 
					npm run serve
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Compiles and minifies for production
 | 
					You can now make changes and see them as soon you save the file!
 | 
				
			||||||
 | 
					 | 
				
			||||||
```
 | 
					 | 
				
			||||||
npm run build
 | 
					 | 
				
			||||||
```
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
### Lints and fixes files
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
```
 | 
					 | 
				
			||||||
npm run lint
 | 
					 | 
				
			||||||
```
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
### Customize configuration
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
See [Configuration Reference](https://cli.vuejs.org/config/).
 | 
					 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue