aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2019-11-13 09:21:32 +0100
committerChocobozzz <me@florianbigard.com>2019-11-13 09:21:32 +0100
commitf0c0c0abd88d0177f8be769f12d5affcacd934e8 (patch)
tree78e92eea650754e4fc6a95de8fcb807a8888ae18 /README.md
parentfe02503052013ca1675aad4ee1eb4a35c2f8359f (diff)
parent9bdcf6248fb59f847d5de32defa923c8236656f6 (diff)
downloadPeerTube-f0c0c0abd88d0177f8be769f12d5affcacd934e8.tar.gz
PeerTube-f0c0c0abd88d0177f8be769f12d5affcacd934e8.tar.zst
PeerTube-f0c0c0abd88d0177f8be769f12d5affcacd934e8.zip
Merge branch 'release/2.0.0' into develop
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 13 insertions, 13 deletions
diff --git a/README.md b/README.md
index 5ed7d5b4c..db61f8909 100644
--- a/README.md
+++ b/README.md
@@ -35,8 +35,8 @@ Be part of a network of multiple small federated, interoperable video hosting pr
35 <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" /> 35 <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" />
36 </a> 36 </a>
37 37
38 <a href="https://www.browserstack.com/automate/public-build/cWJhRDFJbS9qeUhzYW04MnlIVjlQQ0x3aE5POXBaV1lycGo5VlQxK3JqZz0tLTNUWW5ySEVvS1N4UnBhYlhsdXVCeVE9PQ==--db09e291d36a582af8b2929d62a625ed660cdf1d"> 38 <a href="https://automate.browserstack.com/public-build/cW5mYW43VDNUR1Jrb0Y5TnVoaC85Tk84SVhzSU9rS0ppWWJJYUVlRzVQRT0tLW9tVGIvK2ZmOGRld3lVVFRYTFM4aEE9PQ==--591b0056e00a2d1cbdfbcfa324634046132008ec">
39 <img src='https://www.browserstack.com/automate/badge.svg?badge_key=cWJhRDFJbS9qeUhzYW04MnlIVjlQQ0x3aE5POXBaV1lycGo5VlQxK3JqZz0tLTNUWW5ySEVvS1N4UnBhYlhsdXVCeVE9PQ==--db09e291d36a582af8b2929d62a625ed660cdf1d'/> 39 <img src="https://automate.browserstack.com/badge.svg?badge_key=cW5mYW43VDNUR1Jrb0Y5TnVoaC85Tk84SVhzSU9rS0ppWWJJYUVlRzVQRT0tLW9tVGIvK2ZmOGRld3lVVFRYTFM4aEE9PQ==--591b0056e00a2d1cbdfbcfa324634046132008ec"/>
40 </a> 40 </a>
41</p> 41</p>
42 42
@@ -73,7 +73,7 @@ Be part of a network of multiple small federated, interoperable video hosting pr
73Introduction 73Introduction
74---------------------------------------------------------------- 74----------------------------------------------------------------
75 75
76PeerTube 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>. 76PeerTube 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/webtorrent/webtorrent">WebTorrent</a>.
77 77
78To learn more, see: 78To learn more, see:
79* 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 79* 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
@@ -118,7 +118,7 @@ Be it as a user or an instance administrator, you can decide what your experienc
118In 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/#/contribute-architecture?id=redundancy-between-instances">redundancy guide</a>). 118In 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/#/contribute-architecture?id=redundancy-between-instances">redundancy guide</a>).
119</p> 119</p>
120<p align="right"> 120<p align="right">
121Content 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>). 121Content 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="https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md">FAQ</a>).
122</p> 122</p>
123 123
124:raised_hands: Contributing 124:raised_hands: Contributing
@@ -127,7 +127,7 @@ Content creators can get help from their viewers in the simplest way possible: a
127You don't need to be a coder to help! 127You don't need to be a coder to help!
128 128
129You can give us your feedback, report bugs, help us translate PeerTube, write documentation, and more. Check out the [contributing 129You can give us your feedback, report bugs, help us translate PeerTube, write documentation, and more. Check out the [contributing
130guide](/.github/CONTRIBUTING.md) to know how, it takes less than 2 minutes to get started. :wink: 130guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md) to know how, it takes less than 2 minutes to get started. :wink:
131 131
132You can also join the cheerful bunch that makes our community: 132You can also join the cheerful bunch that makes our community:
133 133
@@ -151,14 +151,14 @@ Feel free to reach out if you have any questions or ideas! :speech_balloon:
151 * **yarn >= 1.x** 151 * **yarn >= 1.x**
152 * **FFmpeg >= 3.x** 152 * **FFmpeg >= 3.x**
153 153
154See the [production guide](/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. 154See 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.
155 155
156See the [community packages](https://docs.joinpeertube.org/#/install-unofficial), which cover various platforms (including [YunoHost](https://install-app.yunohost.org/?app=peertube) and [Docker](/support/doc/docker.md)). 156See 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)).
157 157
158:book: Documentation 158:book: Documentation
159---------------------------------------------------------------- 159----------------------------------------------------------------
160 160
161If you have a question, please try to find the answer in the [FAQ](/FAQ.md) first. 161If you have a question, please try to find the answer in the [FAQ](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md) first.
162 162
163### User documentation 163### User documentation
164 164
@@ -166,22 +166,22 @@ See the [user documentation](https://docs.joinpeertube.org/#/use-setup-account).
166 166
167### Admin documentation 167### Admin documentation
168 168
169See [how to create your own instance](#package-create-your-own-instance). 169See [how to create your own instance](https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance).
170 170
171See the more general [admin documentation](https://docs.joinpeertube.org/#/admin-following-instances). 171See the more general [admin documentation](https://docs.joinpeertube.org/#/admin-following-instances).
172 172
173#### Tools 173#### Tools
174 174
175 * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md) 175 * [Import videos (YouTube, Dailymotion, Vimeo...)](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/tools.md)
176 * [Upload videos from the CLI](/support/doc/tools.md) 176 * [Upload videos from the CLI](https://github.com/Chocobozzz/PeerTube/blob/support/doc/tools.md)
177 * [Admin server tools (create transcoding jobs, prune storage...)](/support/doc/tools.md#server-tools) 177 * [Admin server tools (create transcoding jobs, prune storage...)](https://github.com/Chocobozzz/PeerTube/blob/support/doc/tools.md#server-tools)
178 178
179### Technical documentation 179### Technical documentation
180 180
181See the [architecture blueprint](https://docs.joinpeertube.org/#/contribute-architecture) for a more detailed explanation of the architectural choices. 181See the [architecture blueprint](https://docs.joinpeertube.org/#/contribute-architecture) for a more detailed explanation of the architectural choices.
182 182
183See our REST API documentation: 183See our REST API documentation:
184 * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml) 184 * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/support/doc/api/openapi.yaml)
185 * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html) 185 * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html)
186 186
187See our [ActivityPub documentation](https://docs.joinpeertube.org/#/api-activitypub). 187See our [ActivityPub documentation](https://docs.joinpeertube.org/#/api-activitypub).