X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=inline;f=README.md;h=c49d5a27d84d114858a4cfcf39e267ca9c9d46c0;hb=0db1a226507a39b0a663e3e63f04851836a44d5a;hp=5ff05fcb8419751f7349ef5aeb59db3fd5527377;hpb=35501c0fa7be9cb71e992c37e06f3cd01afc510b;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 5ff05fcb8..c49d5a27d 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,12 @@ donating to them](https://soutenir.framasoft.org/en/).**
++ Website | + Instances list + +
+ ## Demonstration Want to see it in action? @@ -70,8 +76,8 @@ Want to see it in action? * [peertube3.cpy.re](http://peertube3.cpy.re) * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504) to see what the "decentralization feature" looks like - -*Currently PeerTube is still in alpha (we plan to release a beta in march). Demonstration servers do not support public registration. If you really want to test PeerTube before the public release, here is a list of PeerTube servers: https://github.com/Chocobozzz/PeerTube/wiki#other-peertube-servers.* + * [Video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) to see + the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon) ## Why @@ -86,49 +92,6 @@ reason why we need to use a P2P protocol to limit the server load. Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus BitTorrent) inside the web browser, as of today. -## Features - -- [X] Angular frontend -- [X] Join the fediverse - - [X] Follow other instances - - [X] Unfollow an instance - - [X] Get for the followers/following list -- [X] Upload a video - - [X] Seed the video - - [X] Send the meta data with ActivityPub to followers -- [X] Remove the video -- [X] List the videos -- [X] View the video in an HTML5 player with WebTorrent -- [X] Admin panel -- [X] OpenGraph tags -- [X] OEmbed -- [X] Update video -- [X] Federated videos view counter -- [X] Federated videos likes/dislikes -- [X] Transcoding to different definitions -- [X] Download file/torrent -- [X] User video bytes quota -- [X] User video channels -- [X] NSFW warnings/settings -- [X] Video description in markdown -- [X] User roles (administrator, moderator) -- [X] User registration -- [X] Video privacy settings (public, unlisted or private) -- [X] Signaling a video to the admin origin PeerTube instance -- [X] Federated videos comments -- [ ] Video imports (URL, Torrent, YouTube...) -- [ ] Advanced search -- [ ] Subtitles -- [ ] User playlist -- [ ] User subscriptions (by tags, author...) -- [ ] Add "DDOS" security - - -## Front compatibility - - * Firefox - * Chrome/Chromium - ## Dependencies * nginx @@ -137,7 +100,7 @@ BitTorrent) inside the web browser, as of today. * **NodeJS >= 8.x** * yarn * OpenSSL (cli) - * FFmpeg + * **FFmpeg >= 3.x** ## Run using Docker @@ -156,14 +119,21 @@ coder to help! ## API REST documentation -For now only on Github: +Quick Start: [/support/doc/api/quickstart.md](/support/doc/api/quickstart.md) + +Endpoints documentation: - * HTML version: [/support/doc/api/html/index.html](/support/doc/api/html/index.html) + * HTML version: [/support/doc/api/html/index.html](https://htmlpreview.github.io/?https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/html/index.html) * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml) ## Tools - * [YouTube import](/support/doc/import-youtube.md) + * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md) + * [Upload videos from the CLI](/support/doc/tools.md) + +## FAQ + +If you have a question, please try to find the answer in the [FAQ](/FAQ.md) first. ## Architecture @@ -194,3 +164,20 @@ Here are some simple schemes: