Client: Update to Angular RC4

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

diff --git a/README.md b/README.md
index 668745c14e001cfce5fc9157c8751ee9a477c5bb..f9c4905a70fcbfbd83730e1040308eb7b6e56ea2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,26 +1,27 @@
 # PeerTube
 
-*Server*
-
+**Server**
 [![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)
 [![devDependency Status](https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg)](https://david-dm.org/Chocobozzz/PeerTube#info=devDependencies)
 [![Code climate](https://codeclimate.com/github/Chocobozzz/PeerTube/badges/gpa.svg)](https://codeclimate.com/github/Chocobozzz/PeerTube)
 
-*Client*
-
+**Client**
 [![Dependency Status](https://david-dm.org/Chocobozzz/PeerTube.svg?path=client)](https://david-dm.org/Chocobozzz/PeerTube?path=client)
 [![devDependency Status](https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client)](https://david-dm.org/Chocobozzz/PeerTube?path=client#info=devDependencies)
 
-Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [WebTorrent](https://github.com/feross/webtorrent).
-
 [![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
 
+Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [WebTorrent](https://github.com/feross/webtorrent).
+
 ![screenshot](https://lutim.cpy.re/vC2loRww)
 
 ## Demonstration
 
-PeerTube is not ready for production yet, but you can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how it looks like.
+Want to see in action?
+
+   * You can directly test in your browser with this [demo server](http://peertube.cpy.re). Don't forget to use the latest version of Firefox/Chromium/(Opera?) and check your firewall configuration (for WebRTC)
+   * You can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like
 
 ## Why
 
@@ -49,13 +50,17 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
 - [X] List the videos
 - [X] Search a video name (local index)
 - [X] View the video in an HTML5 page with WebTorrent
-- [ ]  Manage user accounts
-  - [ ] Inscription
+- [X] Manage admin account
   - [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
 - [ ] 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)
 
 
 ## Installation
@@ -94,7 +99,7 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
 
 ## Usage
 
-### Run the server
+### Development
 
     $ npm start
 
@@ -105,6 +110,18 @@ 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 :)
 
+### 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.
+
+Finally, run the server with the `production` `NODE_ENV` variable set.
+
+    $ NODE_ENV=production npm start
+
 ### Other commands
 
 To print all available command run: