]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - README.md
update modules AND REMOVE SUPPORT OF NODE 0.12 :'(
[github/Chocobozzz/PeerTube.git] / README.md
index 02fcaef7290d24669c3d3992eaec1aeaecd9d2a0..d3d6433a7b7aaa5e67f44fbd3d6cf1ed2308d39b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
 # PeerTube
 
 [![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)
 
 Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [webtorrent](https://github.com/feross/webtorrent).
 
@@ -20,11 +21,12 @@ 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
-- [ ] Join a network
+- [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
@@ -36,7 +38,7 @@ Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (t
   - [ ] Inscription
   - [ ] Connection
   - [ ] Account rights (upload...)
-- [ ] Make the network auto sufficient (eject bad pods etc)
+- [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)
 
@@ -50,11 +52,11 @@ Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (t
 
 ### Dependencies
 
-  * NodeJS == 0.12
+  * **NodeJS >= 4.2**
   * Grunt-cli (npm install -g grunt-cli)
   * OpenSSL (cli)
   * MongoDB
-  * xvfb-run (for electron)
+  * xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 (for electron)
 
 ### Test It!
 
@@ -71,7 +73,9 @@ Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (t
 
 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 :)
 
+### 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.
 
 ## Architecture