X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=ee1c6b12ea591bd60ec3f473bef525f2429dd712;hb=98dffd102ef76872f027fedfc55cc0dc824b5bad;hp=bff2c4e60c460d0fd71dc6e314f8a6b18f7ed5a1;hpb=643a5fc5185ff9829313f22dc76db6b7e173fb49;p=github%2FChocobozzz%2FPeerTube.git

diff --git a/README.md b/README.md
index bff2c4e60..ee1c6b12e 100644
--- 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 />
@@ -100,6 +104,7 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
   - [X] Stats
   - [X] Friends list
   - [X] Manage users (create/remove)
+- [X] OpenGraph tags
 - [ ] User playlists
 - [ ] User subscriptions (by tags, author...)
 - [ ] Signaling a video to the admin pod
@@ -116,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
 
@@ -126,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)
@@ -134,31 +139,20 @@ 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
+    $ npm install # Or npm install --unsafe-perm for root user
     $ npm run build
 
 ## Usage
 
-### Development
-
-    $ npm run dev
-
-### Test with 3 fresh nodes
-
-    $ npm run clean:server:test
-    $ npm run play
-
-Then you will can access to the three nodes at `http://localhost:900{1,2,3}` with the `root` as username and `test{1,2,3}` for the password. 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 :)
-
 ### Production
 
 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.
 
@@ -180,6 +174,19 @@ The following commands will upgrade the source (according to your current branch
     $ npm run upgrade
     # systemctl start peertube
 
+### 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
+
+    $ npm run clean:server:test
+    $ npm run play
+
+Then you will can access to the three nodes at `http://localhost:900{1,2,3}` with the `root` as username and `test{1,2,3}` for the password. 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:
@@ -196,6 +203,8 @@ See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/
 
 See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
 
+See the [client code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md).
+
 
 ## Architecture
 
@@ -229,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>