Small visual change for badge dependencies

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

diff --git a/README.md b/README.md
index 1a738539ac344086268876ddff7ff9cb1f8ce904..fb1e366ec630dd8a1050b649c47d931459920158 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,16 @@
 # PeerTube
 
+*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*
+
+[![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)
 
 Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [webtorrent](https://github.com/feross/webtorrent).
 
@@ -17,14 +27,15 @@ Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (t
 
 ## Features
 
-- [ ] Frontend
-  - [X] Simple frontend (All elements are generated by jQuery)
-  - [ ] AngularJS frontend
-- [ ] Join a network
+- [X] Frontend
+  - [X] ~~Simple frontend (All elements are generated by jQuery)~~
+  - [X] Angular 2 frontend
+- [X] Join a network
   - [X] Generate a RSA key
   - [X] Ask for the friend list of other pods and make friend with them
-  - [ ] Get the list of the videos owned by a pod when making friend with it
-  - [ ] Post the list of its own videos when making friend with another pod
+  - [X] Get the list of the videos owned by a pod when making friend with it
+  - [X] Post the list of its own videos when making friend with another pod
+- [X] Quit a network
 - [X] Upload a video
   - [X] Seed the video
   - [X] Send the meta data to all other friends
@@ -34,14 +45,14 @@ Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (t
 - [X] View the video in an HTML5 page with webtorrent
 - [ ]  Manage user accounts
   - [ ] Inscription
-  - [ ] Connection
-  - [ ] Account rights (upload...)
-- [ ] Make the network auto sufficient (eject bad pods etc)
+  - [X] Connection
+  - [X] Account rights (upload...)
+- [X] Make the network auto sufficient (eject bad pods etc)
 - [ ] Manage API breaks
 - [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
 
 
-## Usage
+## Installation
 
 ### Front compatibility
 
@@ -50,28 +61,48 @@ Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (t
 
 ### Dependencies
 
-  * NodeJS == 0.12
-  * Grunt-cli (npm install -g grunt-cli)
+  * **NodeJS >= 4.2**
   * OpenSSL (cli)
   * MongoDB
-  * xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 (for electron)
+  * 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)
+
+    # 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
+
+#### Other distribution... (PR welcome)
 
-### Test It!
+
+### Sources
 
     $ git clone https://github.com/Chocobozzz/PeerTube
     $ cd PeerTube
-    # npm install -g electron-prebuilt
     $ npm install
+    $ npm run build
+
+## Usage
+
+### Run the server
+
     $ npm start
 
 ### Test with 3 fresh nodes
 
-    $ scripts/clean_test.sh
-    $ scripts/run_servers.sh
+    $ npm run clean:server:test
+    $ npm run play
+
+Then you will can access to the three nodes at `http://localhost:900{1,2,3}`. If you call "make friends" on `http://localhost:9002`, the pod 2 and 3 will become friends. Then if you call "make friends" on `http://localhost:9001` it will become friend with the pod 2 and 3 (check the configuration files). Then the pod will communicate with each others. If you add a video on the pod 3 you'll can see it on the pod 1 and 2 :)
+
+### Other commands
+
+To print all available command run:
 
-Then you will can access to the three nodes at http://localhost:900{1,2,3}. If you call "make friends" on http://localhost:9002, the pod 2 and 3 will become friends. Then if you call "make friends" on http://localhost:9001 it will become friend with the pod 2 and 3 (check the configuration files). Then the pod will communicate with each others. If you add a video on the pod 3 you'll can see it on the pod 1 and 2 :)
+    $ npm run help
 
-### Dockerfile
+## Dockerfile
 
 You can test it inside Docker with the [PeerTube-Docker repository](https://github.com/Chocobozzz/PeerTube-Docker). Moreover it can help you to check how to create an environment with the required dependencies for PeerTube on a GNU/Linux distribution.
 
@@ -97,15 +128,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/aV2pawRz)
+![Decentralized](http://lutim.cpy.re/Q7mnNdJP)
 
-![Watch a video](http://lutim.cpy.re/AlOeoVPi)
+![Watch a video](http://lutim.cpy.re/0riSzAp1)
 
-![Watch a video P2P](http://lutim.cpy.re/fb0JH6C3)
+![Watch a video P2P](http://lutim.cpy.re/OzMSOtxG)
 
-![Join a network](http://lutim.cpy.re/ijuCgmpI)
+![Join a network](http://lutim.cpy.re/uVjNNRa9)
 
-![Many networks](http://lutim.cpy.re/iz8mXHug)
+![Many networks](http://lutim.cpy.re/udTMqcb0)
 
 ### Frontend