Client Better design for video watch

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

diff --git a/README.md b/README.md
index ceba2a3f72e888cfe937816215336c6bdcab6a77..750522dd6905015f45e0c3565dd2076ce1d58f9f 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>.
+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">
@@ -15,7 +15,7 @@ Prototype of a decentralized video streaming platform using P2P (bittorrent) dir
     <img src="https://david-dm.org/Chocobozzz/PeerTube.svg?path=client" alt="Dependency Status" />
   </a>
 
-  <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client#info=devDependencies">
+  <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client#info=dev">
     <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" />
   </a>
 </p>
@@ -26,24 +26,24 @@ Prototype of a decentralized video streaming platform using P2P (bittorrent) dir
   <br />
 
   <a href="https://travis-ci.org/Chocobozzz/PeerTube">
-    <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=master" alt="Build Status" />
+    <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=develop" alt="Build Status" />
   </a>
 
   <a href="https://david-dm.org/Chocobozzz/PeerTube">
     <img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" />
   </a>
 
-  <a href="https://david-dm.org/Chocobozzz/PeerTube#info=devDependencies">
+  <a href="https://david-dm.org/Chocobozzz/PeerTube#info=dev">
     <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
   </a>
 
-  <a href="https://codeclimate.com/github/Chocobozzz/PeerTube">
-    <img src="https://codeclimate.com/github/Chocobozzz/PeerTube/badges/gpa.svg" alt="Code climate" />
-  </a>
-
   <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 />
@@ -74,8 +74,7 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
 ## Features
 
 - [X] Frontend
-  - [X] ~~Simple frontend (All elements are generated by jQuery)~~
-  - [X] Angular 2 frontend
+  - [X] Angular frontend
 - [X] Join a network
   - [X] Generate a RSA key
   - [X] Ask for the friend list of other pods and make friend with them
@@ -93,20 +92,28 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
   - [X] Connection
   - [X] Account rights (upload...)
 - [X] Make the network auto sufficient (eject bad pods etc)
-- [ ] Validate the prototype (test PeerTube in a real world with many pods and videos)
-- [ ] Manage API breaks
+- [X] Validate the prototype (test PeerTube in a real world)
+- [ ] Manage inter pod API breaks
 - [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
 - [X] Admin panel
   - [X] Stats
   - [X] Friends list
   - [X] Manage users (create/remove)
 - [X] OpenGraph tags
+- [X] Update video
+- [X] Videos view count
+- [X] Videos likes/dislikes
+- [ ] Videos comments?
+- [X] User registration
 - [ ] User playlists
 - [ ] User subscriptions (by tags, author...)
-- [ ] Signaling a video to the admin pod
+- [X] Signaling a video to the admin origin pod
+
 
 ## Installation
 
+See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installation commands.
+
 ### Front compatibility
 
   * Chromium
@@ -117,8 +124,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 +134,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 +142,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
@@ -154,8 +161,11 @@ Finally, run the server with the `production` `NODE_ENV` variable set.
 
     $ NODE_ENV=production npm start
 
-**Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx
+The administrator password is automatically generated and can be found in the logs. You can set another password with:
 
+    $ NODE_ENV=production npm run reset-password -- -u root
+
+**Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx <br />
 **Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd
 
 You can check the application (CORS headers, tracker websocket...) by running:
@@ -176,6 +186,9 @@ In this mode, the server will run requests between pods more quickly, the videos
 
     $ npm run dev
 
+**Username**: *root* <br/>
+**Password**: *test*
+
 ### Test with 3 fresh nodes
 
     $ npm run clean:server:test
@@ -234,7 +247,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>