Modify README (travis badge, typos, general organization)

This commit is contained in:
Chocobozzz 2015-10-30 20:18:36 +01:00
parent 2696b9af96
commit 88c8d45819
2 changed files with 23 additions and 15 deletions

View File

@ -1,11 +1,25 @@
# PeerTube
Prototype of a decentralized video streaming platform using P2P (bittorent) directly in the web browser with [webtorrent](https://github.com/feross/webtorrent).
[![Build Status](https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=master)](https://travis-ci.org/Chocobozzz/PeerTube)
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)
## 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.
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.
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.
## Features
- [ ] Frontend
- [X] Simple frontend (All elements are generated by jQuery)
- [ ] AngularJS frontend
- [ ] Join a network
- [X] Generate a RSA key
- [X] Ask for the friend list of other pods and make friend with them
@ -26,14 +40,14 @@ Prototype of a decentralized video streaming platform using P2P (bittorent) dire
- [ ] Manage API breaks
- [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
## Front compatibility
## Usage
### Front compatibility
* Chromium
* Firefox (>= 42 for MediaSource support)
## Usage
### Dependencies
* NodeJS == 0.12
@ -51,19 +65,13 @@ Prototype of a decentralized video streaming platform using P2P (bittorent) dire
$ npm start
### Test with 3 fresh nodes
$ scripts/clean_test.sh
$ scripts/run_servers.sh
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 :)
## 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.
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.
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.
## Architecture
@ -100,4 +108,4 @@ Here are some simple schemes:
### Frontend
There would be a simple frontend (Bootstrap, AngularJS) but since the backend is a REST API anybody could build a frontend (Web application, desktop application...).
The backend uses bittorent protocol, so users could use their favorite bittorent client to download/play the video after having its torrent URI.
The backend uses bittorrent protocol, so users could use their favorite bittorrent client to download/play the video after having its torrent URI.

View File

@ -37,7 +37,7 @@
}
before(function (done) {
this.timeout(20000)
this.timeout(30000)
var path_friends = '/api/pods/makefriends'
utils.runMultipleServers(3, function (apps_run, urls_run) {
@ -65,7 +65,7 @@
done()
})
})
}, 5000)
}, 10000)
})
})
})