Client: split in angular modules

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

diff --git a/README.md b/README.md
index 02f649ac076f40ef71c1668a8f3056001cea312d..efacfc7410b981336d718d01448502474728ca77 100644 (file)
--- a/README.md
+++ b/README.md
@@ -100,9 +100,10 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
   - [X] Stats
   - [X] Friends list
   - [X] Manage users (create/remove)
+- [X] OpenGraph tags
 - [ ] User playlists
 - [ ] User subscriptions (by tags, author...)
-
+- [ ] Signaling a video to the admin pod
 
 ## Installation
 
@@ -136,7 +137,7 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
 
     $ git clone https://github.com/Chocobozzz/PeerTube
     $ cd PeerTube
-    $ npm install
+    $ npm install # Or npm install --unsafe-perm for root user
     $ npm run build
 
 ## Usage
@@ -168,6 +169,18 @@ Finally, run the server with the `production` `NODE_ENV` variable set.
 
 **Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd
 
+You can check the application (CORS headers, tracker websocket...) by running:
+
+    $ NODE_ENV=production npm run check
+
+### Upgrade
+
+The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application:
+
+    # systemctl stop peertube
+    $ npm run upgrade
+    # systemctl start peertube
+
 ### Other commands
 
 To print all available command run: