X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=b06b9c00209078c69ff00c4f8e600292eea67e7f;hb=a73115f31ae891cb47759f075b1d2cead40817a4;hp=cd522301b30e5e9de9e575b63980e5509c9049ea;hpb=649fa07756874e342821fb53840d2d5b2be9c68e;p=github%2FChocobozzz%2FPeerTube.git
diff --git a/README.md b/README.md
index cd522301b..b06b9c002 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,16 @@
Federated (ActivityPub) video streaming platform using P2P (BitTorrent)
directly in the web browser with WebTorrent.
@@ -16,16 +25,12 @@ directly in the web browser with
-
-
-
-
-
-
+
+
@@ -54,20 +59,49 @@ directly in the web browser with
-
-
+
+
-## Getting Started
+:sparkles: Features
+----------------------------------------------------------------
- * **[Website](https://joinpeertube.org)**
- * **[Instances list](https://instances.joinpeertube.org)**
- * 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)**
+
+Video streaming
+
+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!
+
+
+---
+
+
+
+Keep in touch with video creators
+
+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.
+
+
+---
+
+
+
+An interface to call home
+
+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â¢.
+
-## Demonstration
+---
+
+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).
+
+
+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 advertisments that hurt visitors and incentivize alter creativity (more about that in our FAQ).
+
+
+---
Want to see it in action?
@@ -75,13 +109,11 @@ Want to see it in action?
* [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) What is PeerTube?
- * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504)
- to see what the "decentralization feature" looks like
- * [Video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) to see
- the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon)
+ * [Video](https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3) explaining what is PeerTube
+ * [Video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) showing the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon)
-## Why
+:question: Motivation
+----------------------------------------------------------------
We can't build a FOSS video streaming alternative to YouTube, Dailymotion,
Vimeo... with centralized software. One organization alone may not have
@@ -89,73 +121,76 @@ 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. That is
+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 P2P (thus
-BitTorrent) inside the web browser, as of today.
+[WebTorrent](https://github.com/feross/webtorrent), we can make BitTorrent inside the web browser, as of today.
-## Dependencies
+:package: Create your own instance
+----------------------------------------------------------------
+
+#### Dependencies
* nginx
- * PostgreSQL
+ * **PostgreSQL >= 9.6**
* **Redis >= 2.8.18**
* **NodeJS >= 8.x**
- * yarn
- * OpenSSL (cli)
+ * **yarn >= 1.x**
* **FFmpeg >= 3.x**
-## Run in production
+See the [production guide](/support/doc/production.md), which is the recommended way.
-See the [production guide](/support/doc/production.md).
+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)).
-## Run on YunoHost
-[![Install Peertube with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=peertube)
+:wrench: Contribute/Translate/Test
+----------------------------------------------------------------
-Peertube app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/peertube_ynh).
+*Spoiler alert*: you don't need to be a coder to help!
-## Run using Docker
+See the [contributing
+guide](/.github/CONTRIBUTING.md). Or simply join the cheerful bunch that makes our community:
-See the [docker guide](/support/doc/docker.md).
+ * Chat