X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=81fd0ec783eb35966cc5e05927c4370a3d15518f;hb=6cca7360eb9027e1544f7513df7da4684061ef7e;hp=8348d77f827ce1a7315b9b3302b1fab7fca9ec42;hpb=164e6c87787173d9ac4eaf7dd80db4056fd3e354;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 8348d77f8..81fd0ec78 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,14 @@ PeerTube -

+

Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent. -

+

-**PeerTube is sponsored by [Framasoft](https://framatube.org/#en), a non-profit -that promotes, spreads and develops free culture in general, and free-libre -software in particular. If you want to support this project, please [consider -donating to them](https://soutenir.framasoft.org/en/).** +

+We are running a crowdfunding campaign to pave the road to version 1.0 of PeerTube! +

Client @@ -24,6 +23,10 @@ donating to them](https://soutenir.framasoft.org/en/).** devDependency Status + + + +

@@ -60,6 +63,12 @@ donating to them](https://soutenir.framasoft.org/en/).**

+

+ Website | + Instances list + +

+ ## Demonstration Want to see it in action? @@ -70,6 +79,8 @@ Want to see it in action? * [peertube3.cpy.re](http://peertube3.cpy.re) * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504) to see what the "decentralization feature" looks like + * [Video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) to see + the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon) ## Why @@ -98,6 +109,11 @@ BitTorrent) inside the web browser, as of today. See the [docker guide](/support/doc/docker.md) +## Run on YunoHost +[![Install Peertube with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=peertube) + +Peertube app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/peertube_ynh) + ## Production See the [production guide](/support/doc/production.md). @@ -111,9 +127,11 @@ coder to help! ## API REST documentation -For now only on Github: +Quick Start: [/support/doc/api/quickstart.md](/support/doc/api/quickstart.md) - * HTML version: [/support/doc/api/html/index.html](/support/doc/api/html/index.html) +Endpoints documentation: + + * HTML version: [/support/doc/api/html/index.html](https://htmlpreview.github.io/?https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/html/index.html) * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml) ## Tools @@ -154,3 +172,20 @@ Here are some simple schemes: Watch a P2P video

+ +## License + +Copyright (C) 2018 PeerTube Contributors + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as published +by the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU Affero General Public License for more details. + +You should have received a copy of the GNU Affero General Public License +along with this program. If not, see .