Client: generate js files in dist directory

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

diff --git a/README.md b/README.md
index d3adcb94fd20a764526a11675c0567a5add8828b..ee1c6b12ea591bd60ec3f473bef525f2429dd712 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 </h1>
 
 <h4 align="center">
-Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
+Prototype of a decentralized video streaming platform using P2P (BitTorrent) directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
 </h4>
 
 <p align="center">
@@ -44,6 +44,10 @@ Prototype of a decentralized video streaming platform using P2P (bittorrent) dir
   <a href="http://standardjs.com/">
     <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
   </a>
+
+  <a href="https://kiwiirc.com/client/irc.freenode.net/#peertube">
+    <img src="https://img.shields.io/badge/%23peertube-on%20freenode-brightgreen.svg" alt="PeerTube Freenode IRC" />
+  </a>
 </p>
 
 <br />
@@ -117,8 +121,8 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
   * **NodeJS >= 4.x**
   * **npm >= 3.x**
   * OpenSSL (cli)
-  * MongoDB
-  * ffmpeg
+  * PostgreSQL
+  * FFmpeg
 
 #### Debian
 
@@ -127,7 +131,7 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
   * Run:
 
         # apt-get update
-        # apt-get install ffmpeg mongodb openssl
+        # apt-get install ffmpeg postgresql-9.4 openssl
         # npm install -g npm@3
 
 #### Other distribution... (PR welcome)
@@ -135,7 +139,7 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
 
 ### Sources
 
-    $ git clone https://github.com/Chocobozzz/PeerTube
+    $ git clone -b master https://github.com/Chocobozzz/PeerTube
     $ cd PeerTube
     $ npm install # Or npm install --unsafe-perm for root user
     $ npm run build
@@ -148,7 +152,7 @@ If you want to run PeerTube for production (bad idea for now :) ):
 
     $ cp config/production.yaml.example config/production.yaml
 
-Then edit the `config/production.yaml` file according to your webserver configuration.
+Then edit the `config/production.yaml` file according to your webserver configuration. Keys set in this file will override those of `config/default.yml`.
 
 Finally, run the server with the `production` `NODE_ENV` variable set.
 
@@ -172,6 +176,8 @@ The following commands will upgrade the source (according to your current branch
 
 ### Development
 
+In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds and the client files are automatically compiled when we modify them:
+
     $ npm run dev
 
 ### Test with 3 fresh nodes
@@ -232,7 +238,7 @@ Here are some simple schemes:
 
 <img src="https://lutim.cpy.re/MyeS4q1g" alt="Join a network" />
 
-<img src="https://lutim.cpy.re/PqpTTzdP" alt="Many networks"
+<img src="https://lutim.cpy.re/PqpTTzdP" alt="Many networks" />
 
 </p>