Modify video file size to bigint

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

diff --git a/README.md b/README.md
index 6e54e5bdb6313d938d1295c233d607dfcfaf443f..c908d7bcb69213fab679db43aee5bce0969997d8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -49,8 +49,8 @@ Decentralized video streaming platform using P2P (BitTorrent) directly in the we
 <br />
 
 <p align="center">
-  <a href="http://peertube.cpy.re">
-    <img src="https://lutim.cpy.re/vC2loRww" alt="screenshot" />
+  <a href="https://peertube.cpy.re">
+    <img src="https://lutim.cpy.re/9HOUfGK8" alt="screenshot" />
   </a>
 </p>
 
@@ -58,8 +58,8 @@ Decentralized video streaming platform using P2P (BitTorrent) directly in the we
 
 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
+   * [Demo server](http://peertube.cpy.re)
+   * [Video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like
    * Experimental demo servers that share videos (they are in the same network): [peertube2](http://peertube2.cpy.re), [peertube3](http://peertube3.cpy.re). Since I do experiments with them, sometimes they might not work correctly.
 
 ## Why
@@ -123,6 +123,7 @@ See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installatio
 
   * **NodeJS >= 6.x**
   * **npm >= 3.x**
+  * yarn
   * OpenSSL (cli)
   * PostgreSQL
   * FFmpeg
@@ -130,6 +131,7 @@ See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installatio
 #### Debian
 
   * Install NodeJS 6.x (actual LTS): [https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)
+  * Install yarn: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
   * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
   * Run:
 
@@ -143,7 +145,7 @@ See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installatio
 
     $ git clone -b master https://github.com/Chocobozzz/PeerTube
     $ cd PeerTube
-    $ npm install # Or npm install --unsafe-perm for root user
+    $ yarn install
     $ npm run build
 
 ## Usage
@@ -176,14 +178,25 @@ You can check the application (CORS headers, tracker websocket...) by running:
 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
+    $ npm run upgrade-peertube
     # systemctl start peertube
 
 ### Development
 
-In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds and the client files are automatically compiled when we modify them:
+In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds.
 
-    $ npm run dev
+To develop on the server side (server files are automatically compiled when we modify them and the server restarts automatically too):
+
+    $ npm run dev:server
+
+The server (with the client) will listen on `localhost:9000`.
+
+
+To develop on the client side (client files are automatically compiled when we modify them):
+
+    $ npm run dev:client
+
+The API will listen on `localhost:9000` and the frontend on `localhost:3000` (with hot module replacement, you don't need to refresh the web browser).
 
 **Username**: *root* <br/>
 **Password**: *test*
@@ -238,19 +251,19 @@ Here are some simple schemes:
 
 <p align="center">
 
-<img src="https://lutim.cpy.re/isWwz8tt" alt="Decentralized" />
+<img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" />
 
-<img src="https://lutim.cpy.re/VLheltQk" alt="Watch a video" />
+<img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" />
 
-<img src="https://lutim.cpy.re/worHQwKv" alt="Watch a P2P video" />
+<img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
 
-<img src="https://lutim.cpy.re/MyeS4q1g" alt="Join a network" />
+<img src="https://lutim.cpy.re/wWVuczBz.png" alt="Join a network" />
 
-<img src="https://lutim.cpy.re/PqpTTzdP" alt="Many networks" />
+<img src="https://lutim.cpy.re/AMo3uP0D.png" alt="Many networks" />
 
 </p>
 
 ### Frontend
 
-There already is a frontend (Angular 2) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...).
+There already is a frontend (Angular) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...).
 The backend uses BitTorrent protocol, so users could use their favorite BitTorrent client to download/play the video with its torrent URI.