X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=inline;f=README.md;h=fe2ba4883696335a9a8f15c97c532e79f374de0f;hb=a4995eb7ac5745f62604d70f7b2225ff33916d49;hp=f9b4b47e1f7776a989a82755a9ab76f1bd7f4263;hpb=2f050a998e6893168da0bc502df6884700d04e67;p=github%2FChocobozzz%2FPeerTube.git
diff --git a/README.md b/README.md
index f9b4b47e1..fe2ba4883 100644
--- a/README.md
+++ b/README.md
@@ -9,11 +9,21 @@
| Join an instance
| Create an instance
| Chat with us
+ | Donate
-Federated (ActivityPub) video streaming platform using P2P (BitTorrent)
-directly in the web browser with WebTorrent.
+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.
+
+
+
+ Developed with ❤ by Framasoft
+
+
+
+
+
+
@@ -25,8 +35,8 @@ directly in the web browser with
-
-
+
+
@@ -35,8 +45,8 @@ directly in the web browser with
-
-
+
+
@@ -56,10 +66,29 @@ directly in the web browser with
-
+
+Introduction
+----------------------------------------------------------------
+
+PeerTube is a free, decentralized and federated video platform developed as an alternative to other platforms that centralize our data and attention, such as YouTube, Dailymotion or Vimeo. :clapper:
+
+But one organization hosting PeerTube alone may not have enough money to pay for bandwidth and video storage of its servers,
+all servers of PeerTube are interoperable as a federated network, and non-PeerTube servers can be part of the larger Vidiverse
+(federated video network) by talking our implementation of ActivityPub.
+Video load is reduced thanks to P2P in the web browser using WebTorrent or p2p-media-loader.
+
+To learn more, see:
+* This [two-minute video](https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3) (hosted on PeerTube) explaining what PeerTube is and how it works
+* PeerTube's project homepage, [joinpeertube.org](https://joinpeertube.org)
+* Demonstration instances:
+ * [peertube.cpy.re](https://peertube.cpy.re)
+ * [peertube2.cpy.re](https://peertube2.cpy.re)
+ * [peertube3.cpy.re](https://peertube3.cpy.re)
+* This [video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) demonstrating the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon) (a decentralized Twitter alternative)
+
:sparkles: Features
----------------------------------------------------------------
@@ -91,35 +120,29 @@ Be it as a user or an instance administrator, you can decide what your experienc
Communities that help each other
-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).
+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).
+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).
----
-
-Want to see it in action?
+:raised_hands: Contributing
+----------------------------------------------------------------
- * Demonstration servers:
- * [peertube.cpy.re](https://peertube.cpy.re)
- * [peertube2.cpy.re](https://peertube2.cpy.re)
- * [peertube3.cpy.re](https://peertube3.cpy.re)
- * [Video](https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3) explaining what PeerTube is
- * [Video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) showing the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon)
+You don't need to be a coder to help!
-:question: Motivation
-----------------------------------------------------------------
+You can give us your feedback, report bugs, help us translate PeerTube, write documentation, and more. Check out the [contributing
+guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md) to know how, it takes less than 2 minutes to get started. :wink:
-We can't build a FOSS video streaming alternative to YouTube, Dailymotion,
-Vimeo... with centralized software. One organization alone may not have
-enough money to pay for bandwidth and video storage of its servers.
+You can also join the cheerful bunch that makes our community:
-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 popular and overload the server. That is
-why we need to use a P2P protocol to limit the server load. Thanks to
-[WebTorrent](https://github.com/feross/webtorrent), we can make BitTorrent inside the web browser, as of today.
+* Chat:
+ * IRC : **[#peertube on chat.freenode.net:6697](https://kiwiirc.com/client/irc.freenode.net/#peertube)**
+ * Matrix (bridged on IRC and [Discord](https://discord.gg/wj8DDUT)) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)**
+* Forum:
+ * Framacolibri: [https://framacolibri.org/c/peertube](https://framacolibri.org/c/peertube)
+
+Feel free to reach out if you have any questions or ideas! :speech_balloon:
:package: Create your own instance
----------------------------------------------------------------
@@ -129,81 +152,42 @@ why we need to use a P2P protocol to limit the server load. Thanks to
* nginx
* **PostgreSQL >= 9.6**
* **Redis >= 2.8.18**
- * **NodeJS >= 8.x**
+ * **NodeJS >= 10.x**
* **yarn >= 1.x**
* **FFmpeg >= 3.x**
-See the [production guide](/support/doc/production.md), which is the recommended way.
-
-See the [community packages](https://docs.joinpeertube.org/lang/en/docs/install.html), which cover various platforms (including [YunoHost](https://install-app.yunohost.org/?app=peertube) and [Docker](/support/doc/docker.md)).
-
-:wrench: Contribute/Translate/Test
-----------------------------------------------------------------
-
-*Spoiler alert*: you don't need to be a coder to help!
-
-See the [contributing
-guide](/.github/CONTRIBUTING.md). Or simply join the cheerful bunch that makes our community:
+See the [production guide](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/production.md), which is the recommended way to install or upgrade PeerTube. For hardware requirements, see [Should I have a big server to run PeerTube?](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md#should-i-have-a-big-server-to-run-peertube) in the FAQ.
- * Chat:
- * IRC : **[#peertube on chat.freenode.net:6697](https://kiwiirc.com/client/irc.freenode.net/#peertube)**
- * Matrix (bridged on the IRC channel) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)**
- * Forum:
- * Framacolibri: [https://framacolibri.org/c/peertube](https://framacolibri.org/c/peertube)
+See the [community packages](https://docs.joinpeertube.org/#/install-unofficial), which cover various platforms (including [YunoHost](https://install-app.yunohost.org/?app=peertube) and [Docker](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/docker.md)).
:book: Documentation
----------------------------------------------------------------
-If you have a question, please try to find the answer in the [FAQ](/FAQ.md) first.
+If you have a question, please try to find the answer in the [FAQ](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md) first.
### User documentation
-See the [user documentation](https://docs.joinpeertube.org/lang/en/userdocs/).
+See the [user documentation](https://docs.joinpeertube.org/#/use-setup-account).
### Admin documentation
-See [how to create your own instance](#package-create-your-own-instance).
+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/lang/en/docs/).
+See the more general [admin documentation](https://docs.joinpeertube.org/#/admin-following-instances).
-#### Tools
+### Tools documentation
- * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md)
- * [Upload videos from the CLI](/support/doc/tools.md)
- * [Admin server tools (create transcoding jobs, prune storage...)](/support/doc/tools.md#server-tools)
+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 [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation of the architectural choices.
-
-#### Backend
-
- * REST API:
- * Quick Start: [/support/doc/api/quickstart.md](/support/doc/api/quickstart.md)
- * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml)
- * HTML explorer: [/support/doc/api/html/index.html](https://htmlpreview.github.io/?https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/html/index.html)
- * Servers communicate with each other with [Activity
- Pub](https://www.w3.org/TR/activitypub/).
- * Each server has its own users who query it (search videos, query where the
- torrent URI of this specific video is...).
- * When a user uploads a video, the server sends its followers metadata about the video (name, short description, torrent URI...).
- * A server is a tracker responsible for all the videos uploaded on it.
- * Even if nobody watches a video, it is seeded by the server (through
- [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the
- video was uploaded.
+See the [architecture blueprint](https://docs.joinpeertube.org/#/contribute-architecture) for a more detailed explanation of the architectural choices.
-Here are some simple schemes:
-
-
-
-
-
-
-
-
-
-
+See our REST API documentation:
+ * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/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).
:heart: Supports of our crowdfunding
----------------------------------------------------------------
@@ -215,7 +199,7 @@ Quonfucius, IP Solution, \_Laure\_, @lex666, 0x010C, 3dsman, 3rw4n-G3D, aallrd,
## License
-Copyright (C) 2018 PeerTube Contributors
+Copyright (C) 2015-2020 PeerTube Contributors
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