aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorRigel Kent <sendmemail@rigelk.eu>2018-11-23 18:02:08 +0100
committerRigel Kent <sendmemail@rigelk.eu>2018-11-23 18:02:08 +0100
commit3f82804c6cc26a3a67e28d5404d5e5605a6fa4a6 (patch)
treee11927416b1dcc5472f2d5eb1b424ed3532f7197 /README.md
parent1b5e2d72900c8ceaf76940b72839d3c424ac96e8 (diff)
downloadPeerTube-3f82804c6cc26a3a67e28d5404d5e5605a6fa4a6.tar.gz
PeerTube-3f82804c6cc26a3a67e28d5404d5e5605a6fa4a6.tar.zst
PeerTube-3f82804c6cc26a3a67e28d5404d5e5605a6fa4a6.zip
add donate link, move redundancy doc and images to docs.joinpeertube.org
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 8 insertions, 29 deletions
diff --git a/README.md b/README.md
index fb8eb0d0e..a3669353b 100644
--- a/README.md
+++ b/README.md
@@ -9,10 +9,11 @@
9 | <strong><a href="https://instances.joinpeertube.org">Join an instance</a></strong> 9 | <strong><a href="https://instances.joinpeertube.org">Join an instance</a></strong>
10 | <strong><a href="#package-create-your-own-instance">Create an instance</a></strong> 10 | <strong><a href="#package-create-your-own-instance">Create an instance</a></strong>
11 | <strong><a href="#contact">Chat with us</a></strong> 11 | <strong><a href="#contact">Chat with us</a></strong>
12 | <strong><a href="https://framasoft.org/en/#soutenir">Donate</a></strong>
12</p> 13</p>
13 14
14<p align="center"> 15<p align="center">
15Be part of a network of multiple small interconnected, 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. 16Be 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.
16</p> 17</p>
17 18
18<p align="center"> 19<p align="center">
@@ -104,7 +105,7 @@ Be it as a user or an instance administrator, you can decide what your experienc
104 105
105<h3 align="right">Communities that help each other</h3> 106<h3 align="right">Communities that help each other</h3>
106<p align="right"> 107<p align="right">
107In 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 <a href="/support/doc/redundancy.md">redundancy guide</a>). 108In 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 <a href="https://docs.joinpeertube.org/lang/en/devdocs/architecture.html#redundancy-between-instances">redundancy guide</a>).
108</p> 109</p>
109<p align="right"> 110<p align="right">
110Content 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 <strike>incentivize</strike> alter creativity (more about that in our <a href="./FAQ.md">FAQ</a>). 111Content 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 <strike>incentivize</strike> alter creativity (more about that in our <a href="./FAQ.md">FAQ</a>).
@@ -167,35 +168,13 @@ See the more general [admin documentation](https://docs.joinpeertube.org/lang/en
167 168
168### Technical documentation 169### Technical documentation
169 170
170See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation of the architectural choices. 171See the [architecture blueprint](https://docs.joinpeertube.org/lang/en/devdocs/architecture.html) for a more detailed explanation of the architectural choices.
171 172
172#### Backend 173See our REST API documentation:
173 174 * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml)
174 * REST API: 175 * Spec explorer: [docs.joinpeertube.org/api.html](http://docs.joinpeertube.org/api.html)
175 * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml)
176 * HTML explorer: [docs.joinpeertube.org/api.html](http://docs.joinpeertube.org/api.html)
177 * Servers communicate with each other with [Activity
178 Pub](https://www.w3.org/TR/activitypub/).
179 * Each server has its own users who query it (search videos, query where the
180 torrent URI of this specific video is...).
181 * When a user uploads a video, the server sends its followers metadata about the video (name, short description, torrent URI...).
182 * A server is a tracker responsible for all the videos uploaded on it.
183 * Even if nobody watches a video, it is seeded by the server (through
184 [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the
185 video was uploaded.
186
187Here are some simple schemes:
188
189<p align="center">
190
191<img src="support/doc/user/decentralized.png" alt="Decentralized" />
192
193<img src="support/doc/user/watch-video.png" alt="Watch a video" />
194
195<img src="support/doc/user/watch-p2p.png" alt="Watch a P2P video" />
196
197</p>
198 176
177See our [ActivityPub documentation](https://docs.joinpeertube.org/lang/en/devdocs/federation.html).
199 178
200:heart: Supports of our crowdfunding 179:heart: Supports of our crowdfunding
201---------------------------------------------------------------- 180----------------------------------------------------------------