Client: add views information and sort

[oweals/peertube.git] / README.md

diff --git a/README.md b/README.md
index a25f058f8a8f1fd4f75986b54549d38a72d9f1a4..8a2a60c8fd006d96f86457ef19e67faede961a3e 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">
@@ -26,7 +26,7 @@ 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">
@@ -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,7 +92,7 @@ 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)
+- [X] Validate the prototype (test PeerTube in a real world)
 - [ ] Manage API breaks
 - [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
 - [X] Admin panel
@@ -103,7 +102,9 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
 - [X] OpenGraph tags
 - [ ] User playlists
 - [ ] User subscriptions (by tags, author...)
-- [ ] Signaling a video to the admin pod
+- [X] Signaling a video to the admin origin pod
+- [ ] Videos view count
+- [ ] Videos likes/dislikes
 
 ## Installation
 
@@ -154,6 +155,10 @@ Finally, run the server with the `production` `NODE_ENV` variable set.
 
     $ NODE_ENV=production npm start
 
+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
 
 **Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd
@@ -176,6 +181,8 @@ In this mode, the server will run requests between pods more quickly, the videos
 
     $ npm run dev
 
+The administrator password is displayed in the command output and can be found in the logs.
+
 ### Test with 3 fresh nodes
 
     $ npm run clean:server:test