aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorRigel Kent <sendmemail@rigelk.eu>2018-11-22 16:27:27 +0100
committerRigel Kent <sendmemail@rigelk.eu>2018-11-22 16:27:27 +0100
commitf95cb03a29716a455ad89877dfd5192d825e3931 (patch)
tree1264e1a1b6f618ff3491c283855bbffbcdcc287a
parent9644c2a88eb227e7441b0f0a75abb75b41cc60ca (diff)
downloadPeerTube-f95cb03a29716a455ad89877dfd5192d825e3931.tar.gz
PeerTube-f95cb03a29716a455ad89877dfd5192d825e3931.tar.zst
PeerTube-f95cb03a29716a455ad89877dfd5192d825e3931.zip
(doc) less technical headline, more compact introduction
* FAQ: moving motivation from README. * README: headline is more appealing to a non-technical public. Introduction now presents WebTorrent and ActivityPub.
-rw-r--r--FAQ.md23
-rw-r--r--README.md27
2 files changed, 28 insertions, 22 deletions
diff --git a/FAQ.md b/FAQ.md
index ac75d1321..34e365874 100644
--- a/FAQ.md
+++ b/FAQ.md
@@ -5,6 +5,7 @@
5<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> 5<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
6 6
7 7
8- [Why did you create PeerTube?](#why-did-you-create-peertube)
8- [I don't like the name "PeerTube"](#i-dont-like-the-name-peertube) 9- [I don't like the name "PeerTube"](#i-dont-like-the-name-peertube)
9- [If nobody watches a video, is it seeded?](#if-nobody-watches-a-video-is-it-seeded) 10- [If nobody watches a video, is it seeded?](#if-nobody-watches-a-video-is-it-seeded)
10- [What is WebSeed?](#what-is-webseed) 11- [What is WebSeed?](#what-is-webseed)
@@ -22,6 +23,28 @@
22 23
23<!-- END doctoc generated TOC please keep comment here to allow auto update --> 24<!-- END doctoc generated TOC please keep comment here to allow auto update -->
24 25
26## Why did you create PeerTube?
27
28We can't build a FOSS video streaming alternative to YouTube, Dailymotion,
29Vimeo... with centralized software. One organization alone may not have
30enough money to pay for bandwidth and video storage of its servers.
31
32Our stance is that only a decentralized network of servers can provide an
33acceptable answer to technical issues (bandwidth, transcoding expenses, etc.)
34and social answers (need for a particular moderation policy, preserving
35content, etc.).
36
37While a paragraph is not enough to answer all these problems, PeerTube has
38very early prouded itself for using a contributory design, both for creating
39communities as federated nodes (as [Mastodon](https://joinmastodon.org/) for
40example), and for seeding videos (instances can seed each other's videos). But it's not
41enough because one video could become popular and overload the server. That is
42why we need to use a P2P protocol to limit the server load. Thanks to
43[WebTorrent](https://github.com/feross/webtorrent), we can use BitTorrent
44inside most modern web browsers, and users become seeds as the video gets
45more viewers.
46
47
25## I don't like the name "PeerTube" 48## I don't like the name "PeerTube"
26 49
27PeerTube is just the name of the software. You can install it on your 50PeerTube is just the name of the software. You can install it on your
diff --git a/README.md b/README.md
index 6a799a526..fb8eb0d0e 100644
--- a/README.md
+++ b/README.md
@@ -12,8 +12,7 @@
12</p> 12</p>
13 13
14<p align="center"> 14<p align="center">
15Federated (ActivityPub) video streaming platform using P2P (BitTorrent) 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.
16directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
17</p> 16</p>
18 17
19<p align="center"> 18<p align="center">
@@ -63,19 +62,16 @@ directly in the web browser with <a href="https://github.com/feross/webtorrent">
63Introduction 62Introduction
64---------------------------------------------------------------- 63----------------------------------------------------------------
65 64
66PeerTube 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: 65PeerTube 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 (BitTorrent) in the web browser via <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
67
68PeerTube is a software that enables the creation of a network of multiple small interconnected video hosting providers, called instances. :movie_camera: :globe_with_meridians:
69 66
70To learn more, see: 67To learn more, see:
71 68* 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
72* This [two-minute video](https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3) explaining what PeerTube is and how it works (hosted on PeerTube, of course :wink:) 69* PeerTube's project homepage, [joinpeertube.org](https://joinpeertube.org)
73* PeerTube's Website, [joinpeertube.org](https://joinpeertube.org)
74* Demonstration instances: 70* Demonstration instances:
75 * [peertube.cpy.re](https://peertube.cpy.re) 71 * [peertube.cpy.re](https://peertube.cpy.re)
76 * [peertube2.cpy.re](https://peertube2.cpy.re) 72 * [peertube2.cpy.re](https://peertube2.cpy.re)
77 * [peertube3.cpy.re](https://peertube3.cpy.re) 73 * [peertube3.cpy.re](https://peertube3.cpy.re)
78* 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) (decentralized Twitter alternative) 74* 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)
79 75
80:sparkles: Features 76:sparkles: Features
81---------------------------------------------------------------- 77----------------------------------------------------------------
@@ -114,19 +110,6 @@ In addition to visitors using WebTorrent to share the load among them, instances
114Content 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>). 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>).
115</p> 111</p>
116 112
117:question: Motivation
118----------------------------------------------------------------
119
120We can't build a FOSS video streaming alternative to YouTube, Dailymotion,
121Vimeo... with centralized software. One organization alone may not have
122enough money to pay for bandwidth and video storage of its servers.
123
124So we need to have a decentralized network of servers seeding videos (as
125[Diaspora](https://github.com/diaspora/diaspora) for example). But it's not
126enough because one video could become popular and overload the server. That is
127why we need to use a P2P protocol to limit the server load. Thanks to
128[WebTorrent](https://github.com/feross/webtorrent), we can make BitTorrent inside the web browser, as of today.
129
130:raised_hands: Contributing 113:raised_hands: Contributing
131---------------------------------------------------------------- 114----------------------------------------------------------------
132 115