Add dev dependency badge to readme

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

diff --git a/README.md b/README.md
index 87117f5f4740db5b673151472bbbf19847066be6..34cddc56f454eb411aea4c27285861c19f521126 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,6 +2,7 @@
 
 [![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)
 
 Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [webtorrent](https://github.com/feross/webtorrent).
@@ -21,7 +22,7 @@ Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (t
 
 - [ ] Frontend
   - [X] Simple frontend (All elements are generated by jQuery)
-  - [ ] AngularJS frontend
+  - [ ] 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
@@ -54,17 +55,15 @@ Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (t
 ### Dependencies
 
   * **NodeJS >= 4.2**
-  * Grunt-cli (npm install -g grunt-cli)
   * 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
-    # npm install -g grunt-cli
+    # 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
 
 
@@ -74,12 +73,13 @@ Install NodeJS 4.2: [https://nodejs.org/en/download/package-manager/#debian-and-
     $ cd PeerTube
     # npm install -g electron-prebuilt
     $ npm install
+    $ npm run build
     $ npm start
 
 ### Test with 3 fresh nodes
 
-    $ scripts/clean_test.sh
-    $ scripts/run_servers.sh
+    $ bin/clean_test.sh
+    $ bin/run_servers.sh
 
 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 :)