Use async waterfall in request scheduler for better readability

[github/Chocobozzz/PeerTube.git] / README.md

diff --git a/README.md b/README.md
index 37bee455dce2f732d3039bd6bbb5a6d375f35b3c..3c9a6e4d94af736944dee6608fb85cc0d3ec1c48 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,20 +1,24 @@
 # PeerTube
 
-*Server*
-
+**Server**
 [![Build Status](https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=master)](https://travis-ci.org/Chocobozzz/PeerTube)
 [![Dependencies Status](https://david-dm.org/Chocobozzz/PeerTube.svg)](https://david-dm.org/Chocobozzz/PeerTube)
 [![devDependency Status](https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg)](https://david-dm.org/Chocobozzz/PeerTube#info=devDependencies)
 [![Code climate](https://codeclimate.com/github/Chocobozzz/PeerTube/badges/gpa.svg)](https://codeclimate.com/github/Chocobozzz/PeerTube)
 
-*Client*
-
+**Client**
 [![Dependency Status](https://david-dm.org/Chocobozzz/PeerTube.svg?path=client)](https://david-dm.org/Chocobozzz/PeerTube?path=client)
 [![devDependency Status](https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client)](https://david-dm.org/Chocobozzz/PeerTube?path=client#info=devDependencies)
 
+[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
+
 Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [WebTorrent](https://github.com/feross/webtorrent).
 
-[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
+![screenshot](https://lutim.cpy.re/vC2loRww)
+
+## Demonstration
+
+PeerTube is not ready for production yet, but you can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how it looks like.
 
 ## Why
 
@@ -64,14 +68,17 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
   * **NodeJS >= 4.2**
   * OpenSSL (cli)
   * MongoDB
-  * xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron)
+  * ffmpeg xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron)
 
 #### Debian
 
-Install NodeJS 4.2: [https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)
+  * Install NodeJS 4.2: [https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)
+  * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
+  * Run:
 
-    # apt-get install mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin
-    # npm install -g electron-prebuilt
+        # apt-get update
+        # apt-get install ffmpeg mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin
+        # npm install -g electron-prebuilt
 
 #### Other distribution... (PR welcome)
 
@@ -128,15 +135,15 @@ See the ARCHITECTURE.md for more informations. Do not hesitate to give your opin
 
 Here are some simple schemes:
 
-![Decentralized](http://lutim.cpy.re/Q7mnNdJP)
+![Decentralized](https://lutim.cpy.re/Q7mnNdJP)
 
-![Watch a video](http://lutim.cpy.re/0riSzAp1)
+![Watch a video](https://lutim.cpy.re/0riSzAp1)
 
-![Watch a video P2P](http://lutim.cpy.re/OzMSOtxG)
+![Watch a video P2P](https://lutim.cpy.re/OzMSOtxG)
 
-![Join a network](http://lutim.cpy.re/uVjNNRa9)
+![Join a network](https://lutim.cpy.re/uVjNNRa9)
 
-![Many networks](http://lutim.cpy.re/udTMqcb0)
+![Many networks](https://lutim.cpy.re/udTMqcb0)
 
 ### Frontend