X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=61dc7c9f9b78857089674e3b365c611d8facd497;hb=36e5e1d7a68aeb59e2cf17691c922213b606b249;hp=3c9a6e4d94af736944dee6608fb85cc0d3ec1c48;hpb=b4c5a1f8ea0249ea48089b7fbc324c1d8de57219;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 3c9a6e4d9..61dc7c9f9 100644 --- a/README.md +++ b/README.md @@ -1,151 +1,196 @@ -# PeerTube +
+ Website + | Join an instance + | Create an instance + | Chat with us + | Donate +
+ ++Be part of a network of multiple small federated, interoperable video hosting providers. Follow video creators and create videos. No vendor lock-in. All on a platform that is community-owned and ad-free. +
+ ++ Developed with ❤ by Framasoft +
+ ++ + + +
+ +
+ Client
-**Server**
-[![Build Status](https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=master)](https://travis-ci.org/Chocobozzz/PeerTube)
-[![Dependencies Status](https://david-dm.org/Chocobozzz/PeerTube.svg)](https://david-dm.org/Chocobozzz/PeerTube)
-[![devDependency Status](https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg)](https://david-dm.org/Chocobozzz/PeerTube#info=devDependencies)
-[![Code climate](https://codeclimate.com/github/Chocobozzz/PeerTube/badges/gpa.svg)](https://codeclimate.com/github/Chocobozzz/PeerTube)
+
-**Client**
-[![Dependency Status](https://david-dm.org/Chocobozzz/PeerTube.svg?path=client)](https://david-dm.org/Chocobozzz/PeerTube?path=client)
-[![devDependency Status](https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client)](https://david-dm.org/Chocobozzz/PeerTube?path=client#info=devDependencies)
+
+
+
-[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
+
+
+
+
+ Server
-![screenshot](https://lutim.cpy.re/vC2loRww)
+
-## Demonstration
+
+
+
-PeerTube is not ready for production yet, but you can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how it looks like.
+
+
+
+
+ + + +
-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. +Introduction +---------------------------------------------------------------- -## Features +PeerTube is a free, decentralized and federated video platform developed as an alternative to other platforms that centralize our data and attention, such as YouTube, Dailymotion or Vimeo. :clapper: -- [X] Frontend - - [X] ~~Simple frontend (All elements are generated by jQuery)~~ - - [X] Angular 2 frontend -- [X] Join a network - - [X] Generate a RSA key - - [X] Ask for the friend list of other pods and make friend with them - - [X] Get the list of the videos owned by a pod when making friend with it - - [X] Post the list of its own videos when making friend with another pod -- [X] Quit a network -- [X] Upload a video - - [X] Seed the video - - [X] Send the meta data to all other friends -- [X] Remove the video -- [X] List the videos -- [X] Search a video name (local index) -- [X] View the video in an HTML5 page with WebTorrent -- [ ] Manage user accounts - - [ ] Inscription - - [X] Connection - - [X] Account rights (upload...) -- [X] Make the network auto sufficient (eject bad pods etc) -- [ ] Manage API breaks -- [ ] Add "DDOS" security (check if a pod don't send too many requests for example) +To learn more: +* This [two-minute video](https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3) (hosted on PeerTube) explaining what PeerTube is and how it works +* PeerTube's project homepage, [joinpeertube.org](https://joinpeertube.org) +* Demonstration instances: + * [peertube.cpy.re](https://peertube.cpy.re) (stable) + * [peertube2.cpy.re](https://peertube2.cpy.re) (Nightly) + * [peertube3.cpy.re](https://peertube3.cpy.re) (RC) +* This [video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) demonstrating the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon) (a decentralized Twitter alternative) +:sparkles: Features +---------------------------------------------------------------- -## Installation ++ All features for viewers + | All features for content creators + | All features for administrators +
-### Front compatibility + ++Just upload your videos, and be sure they will stream anywhere. Add a description, some tags and your video will be discoverable by the entire video fediverse, not just your instance. You can even embed a player on your favorite website! +
++You are used to hosting live events? We got you covered too! Start livestreaming from your favorite client, and even host permanent streams! +
- * Chromium - * Firefox (>= 42 for MediaSource support) +--- -### Dependencies + - * **NodeJS >= 4.2** - * OpenSSL (cli) - * MongoDB - * ffmpeg xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron) ++Follow your favorite channels from PeerTube or really any other place. No need to have an account on the instance you watched a video to follow its author, you can do all of that from the Fediverse (Mastodon, Pleroma, and plenty others), or just with good ol' RSS. +
-#### Debian +--- - * Install NodeJS 4.2: [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) - * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/ - * Run: + - # apt-get update - # apt-get install ffmpeg mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin - # npm install -g electron-prebuilt ++Be it as a user or an instance administrator, you can decide what your experience will be like. Don't like the colors? They are easy to change. Don't want to list videos of an instance but let your users subscribe to them? Don't like the regular web client? All of that can be changed, and much more. No UX dark pattern, no mining your data, no video recommendation bullshitâ¢. +
-#### Other distribution... (PR welcome) +--- ++In addition to visitors using WebTorrent to share the load among them, instances can help each other by caching one another's videos. This way even small instances have a way to show content to a wider audience, as they will be shouldered by friend instances (more about that in our redundancy guide). +
+
+Content creators can get help from their viewers in the simplest way possible: a support button showing a message linking to their donation accounts or really anything else. No more pay-per-view and advertisements that hurt visitors and incentivize alter creativity (more about that in our FAQ).
+