Try to fix Traviis build (caused by npm 2)

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

diff --git a/README.md b/README.md
index e089954c847b1731cc51b1367e83944f4d3dbc64..23189d66786ec39ea0f10af69c39f557b3ee85d2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -96,9 +96,9 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
 - [ ] Manage API breaks
 - [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
 - [ ] Admin panel
-  - [ ] Stats about the network (how many friends, how many requests per hour...)
   - [ ] Stats about videos
-  - [ ] Manage users (create/remove)
+  - [X] Friends list
+  - [X] Manage users (create/remove)
 
 
 ## Installation
@@ -139,14 +139,14 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
 
 ### Development
 
-    $ npm start
+    $ 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}`. 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 :)
+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
 
@@ -170,6 +170,13 @@ To print all available command run:
 
 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.
 
+## Contributing
+
+See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md).
+
+See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
+
+
 ## Architecture
 
 See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
@@ -182,7 +189,7 @@ See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITE
     * Each server of a network has a list of all other servers of this network
     * When a new installed server wants to join a network, it just has to get the servers list through a server that is already in the network and tell "Hi I'm new in the network, communicate with me and share me your servers list please". Then the server will "make friend" with each server of this list
     * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
-    * If an user upload a video, the server seeds it and sends the video informations (name, short description, torrent URI...) to each server of the network
+    * If a user upload a video, the server seeds it and sends the video informations (name, short description, torrent URI...) to each server of the network
     * Each server has a RSA key to encrypt and sign communications with other servers
   * A server is a tracker responsible for all the videos uploaded in it
   * Even if nobody watches a video, it is seeded by the server where the video was uploaded