]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - README.md
Send follow/accept
[github/Chocobozzz/PeerTube.git] / README.md
index 8248e3a7c8179083b86dc0e801287b1097591f36..35d53ee0967c2b08092ac05b5120e291ae566f1c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,6 +6,8 @@
 Decentralized video streaming platform using P2P (BitTorrent) directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
 </h4>
 
+**PeerTube is sponsored by [Framasoft](https://framatube.org/#en), a non-profit that promotes, spreads and develops free-libre software. If you want to support this project, please [consider donating them](https://soutenir.framasoft.org/en/).**
+
 <p align="center">
   <strong>Client</strong>
 
@@ -64,10 +66,10 @@ Want to see in action?
 
 ## Why
 
-We can't build a FOSS video streaming alternatives to YouTube, Dailymotion, Vimeo... with a centralized software. One organization alone cannot have enought money to pay bandwith and video storage of its server.
+We can't build a FOSS video streaming alternatives to YouTube, Dailymotion, Vimeo... with a centralized software. One organization alone cannot have enough money to pay bandwidth and video storage of its server.
 
 So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
-But it's not enought because one video could become famous and overload the server.
+But it's not enough because one video could become famous and overload the server.
 It's the reason why we need to use a P2P protocol to limit the server load.
 Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
 
@@ -100,14 +102,23 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
   - [X] Friends list
   - [X] Manage users (create/remove)
 - [X] OpenGraph tags
+- [X] OEmbed
 - [X] Update video
-- [X] Videos view count
+- [X] Videos view counter
 - [X] Videos likes/dislikes
-- [ ] Videos comments?
+- [X] Transcoding to different definitions
+- [X] Download file/torrent
+- [X] User video bytes quota
+- [X] User channels
+- [X] NSFW warnings/settings
+- [X] Video description in markdown
+- [X] User roles (administrator, moderator)
 - [X] User registration
-- [ ] User playlists
-- [ ] User subscriptions (by tags, author...)
+- [X] Video privacy settings (public, unlisted or private)
 - [X] Signaling a video to the admin origin pod
+- [ ] Videos comments
+- [ ] User playlist
+- [ ] User subscriptions (by tags, author...)
 
 
 ## Installation
@@ -183,9 +194,9 @@ The following commands will upgrade the source (according to your current branch
 
 ### Development
 
-In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds.
+In this mode, the server will run requests between pods more quickly, the video durations are limited to a few seconds.
 
-To develop on the server side (server files are automatically compiled when we modify them and the server restarts automatically too):
+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
 
@@ -206,7 +217,7 @@ The API will listen on `localhost:9000` and the frontend on `localhost:3000` (wi
     $ npm run clean:server:test
     $ npm run play
 
-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 :)
+Then you will get 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 :)
 
 ### Other commands
 
@@ -239,13 +250,13 @@ 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 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
+    * If a user upload a video, the server seeds it and sends the video information (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 (throught [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the video was uploaded
-  * A network can live and evolve by expelling bad pod (with too many downtimes for example)
+  * Even if nobody watches a video, it is seeded by the server (through [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the video was uploaded
+  * A network can live and evolve by expelling bad pod (with too many downtime for example)
 
-See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
+See the ARCHITECTURE.md for more information. Do not hesitate to give your opinion :)
 
 Here are some simple schemes: