X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=b48634f144e973e9253f29ca6c9c28a4dad80185;hb=1255f22de407d01649f595f3a0e72865a2cccd08;hp=0802662cb0fc28bd5a9e85cd6a26cc3c01be56bb;hpb=9940241328acd0bf1bed62f2e83a8122b5d5daf4;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 0802662cb..b48634f14 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,42 @@
+ Website + | Join an instance + | Create an instance + | Chat with us + | Donate +
+ ++Be part of a network of multiple small federated, interoperable video hosting providers. Follow video creators and create videos. No vendor lock-in. All on a platform that is community-owned and ad-free. +
-**PeerTube is sponsored by [Framasoft](https://framatube.org/#en), a non-profit -that promotes, spreads and develops free culture in general, and free-libre -software in particular. If you want to support this project, please [consider -donating to them](https://soutenir.framasoft.org/en/).** ++ Developed with ❤ by Framasoft +
+ ++ + + +
@@ -31,173 +45,152 @@ donating to them](https://soutenir.framasoft.org/en/).**+ All features for viewers + | All features for content creators + | All features for administrators +
+ + ++Just upload your videos, and be sure they will stream anywhere. Add a description, some tags and your video will be discoverable by the entire video fediverse, not just your instance. You can even embed a player on your favorite website! +
++You are used to hosting live events? We got you covered too! Start livestreaming from your favorite client, and even host permanent streams! +
-## Why +--- -We can't build a FOSS video streaming alternatives to YouTube, Dailymotion, -Vimeo... with a centralized software. One organization alone may not have -enough money to pay for bandwidth and video storage of its servers. + -So we need to have a decentralized network of servers seeding videos (as -[Diaspora](https://github.com/diaspora/diaspora) for example). But it's not -enough because one video could become famous and overload the server. It's the -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. ++Follow your favorite channels from PeerTube or really any other place. No need to have an account on the instance you watched a video to follow its author, you can do all of that from the Fediverse (Mastodon, Pleroma, and plenty others), or just with good ol' RSS. +
-## 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 -- [X] Update video thumbnails -- [X] Support video uploader button -- [ ] Video imports (URL, Torrent, YouTube...) -- [ ] Advanced search -- [ ] Subtitles -- [ ] User playlist -- [ ] User subscriptions (by tags, author...) -- [ ] Add "DDOS" security +--- + -## Front compatibility ++Be it as a user or an instance administrator, you can decide what your experience will be like. Don't like the colors? They are easy to change. Don't want to list videos of an instance but let your users subscribe to them? Don't like the regular web client? All of that can be changed, and much more. No UX dark pattern, no mining your data, no video recommendation bullshitâ¢. +
- * Firefox - * Chrome/Chromium +--- -## Dependencies ++In addition to visitors using WebTorrent to share the load among them, instances can help each other by caching one another's videos. This way even small instances have a way to show content to a wider audience, as they will be shouldered by friend instances (more about that in our redundancy guide). +
+
+Content creators can get help from their viewers in the simplest way possible: a support button showing a message linking to their donation accounts or really anything else. No more pay-per-view and advertisements that hurt visitors and incentivize alter creativity (more about that in our FAQ).
+
+:book: Documentation +---------------------------------------------------------------- - +If you have a question, please try to find the answer in the [FAQ](https://joinpeertube.org/faq) first. - +### User documentation - +See the [user documentation](https://docs.joinpeertube.org/use-setup-account). -
+### Admin documentation + +See [how to create your own instance](https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance). + +See the more general [admin documentation](https://docs.joinpeertube.org/admin-following-instances). + +### Tools documentation + +Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/maintain-tools). + +### Technical documentation + +See the [architecture blueprint](https://docs.joinpeertube.org/contribute-architecture) for a more detailed explanation of the architectural choices. + +See our REST API documentation: + * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml) + * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html) + +See our [ActivityPub documentation](https://docs.joinpeertube.org/api-activitypub). + +## License + +Copyright (C) 2015-2021 PeerTube Contributors (see [CREDITS.md](CREDITS.md)) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as published +by the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU Affero General Public License for more details. + +You should have received a copy of the GNU Affero General Public License +along with this program. If not, see