Client: reset pagination when we search something

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

diff --git a/README.md b/README.md
index 19c277977389d8fc91d9971a5a3973ecfc28e27d..1a3470711be0f82feeca1548fbd036eecce22383 100644 (file)
--- a/README.md
+++ b/README.md
@@ -41,14 +41,18 @@ Prototype of a decentralized video streaming platform using P2P (bittorrent) dir
     <img src="https://codeclimate.com/github/Chocobozzz/PeerTube/badges/gpa.svg" alt="Code climate" />
   </a>
 
-  <br />
-
-  <a href="https://github.com/feross/standard">
-    <img src="https://cdn.rawgit.com/feross/standard/master/badge.svg" alt="js-standard-style" />
+  <a href="http://standardjs.com/">
+    <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
   </a>
 </p>
 
-![screenshot](https://lutim.cpy.re/vC2loRww)
+<br />
+
+<p align="center">
+  <a href="http://peertube.cpy.re">
+    <img src="https://lutim.cpy.re/vC2loRww" alt="screenshot" />
+  </a>
+</p>
 
 ## Demonstration
 
@@ -135,14 +139,14 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
 
 ### Development
 
-    $ npm start
+    $ npm run dev
 
 ### Test with 3 fresh nodes
 
     $ npm run clean:server:test
     $ npm run play
 
-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 :)
+Then you will can access to the three nodes at `http://localhost:900{1,2,3}` with the `root` as username and `test{1,2,3}` for the password. 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
 
@@ -166,6 +170,13 @@ To print all available command run:
 
 You can test it inside Docker with the [PeerTube-Docker repository](https://github.com/Chocobozzz/PeerTube-Docker). Moreover it can help you to check how to create an environment with the required dependencies for PeerTube on a GNU/Linux distribution.
 
+## Contributing
+
+See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md).
+
+See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
+
+
 ## Architecture
 
 See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
@@ -178,7 +189,7 @@ See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITE
     * Each server of a network has a list of all other servers of this network
     * When a new installed server wants to join a network, it just has to get the servers list through a server that is already in the network and tell "Hi I'm new in the network, communicate with me and share me your servers list please". Then the server will "make friend" with each server of this list
     * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
-    * If an user upload a video, the server seeds it and sends the video informations (name, short description, torrent URI...) to each server of the network
+    * If a user upload a video, the server seeds it and sends the video informations (name, short description, torrent URI...) to each server of the network
     * Each server has a RSA key to encrypt and sign communications with other servers
   * A server is a tracker responsible for all the videos uploaded in it
   * Even if nobody watches a video, it is seeded by the server where the video was uploaded
@@ -205,5 +216,5 @@ Here are some simple schemes:
 
 ### Frontend
 
-There is already 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 2) 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.