X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=README.md;h=22ee2270169fa2c596c1bdea2fad9e73f5225852;hb=11fa7d392a21fe73dd235375b89c554e9b5ba18c;hp=8348d77f827ce1a7315b9b3302b1fab7fca9ec42;hpb=164e6c87787173d9ac4eaf7dd80db4056fd3e354;p=oweals%2Fpeertube.git diff --git a/README.md b/README.md index 8348d77f8..22ee22701 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,16 +63,24 @@ donating to them](https://soutenir.framasoft.org/en/).**

+## Getting Started + + * **[Website](https://joinpeertube.org)** + * **[Instances list](https://instances.joinpeertube.org)** + ## Demonstration Want to see it in action? * Demonstration servers: - * [peertube.cpy.re](http://peertube.cpy.re) - * [peertube2.cpy.re](http://peertube2.cpy.re) - * [peertube3.cpy.re](http://peertube3.cpy.re) + * [peertube.cpy.re](https://peertube.cpy.re) + * [peertube2.cpy.re](https://peertube2.cpy.re) + * [peertube3.cpy.re](https://peertube3.cpy.re) + * [Video](https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3) What is PeerTube? * [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,22 +109,29 @@ 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). -## Contributing/Test +## Contribute/Translate/Test See the [contributing guide](/.github/CONTRIBUTING.md) -to see how to test or contribute to PeerTube. Spoiler alert: you don't need to be a +to see how to test or contribute to PeerTube (write documentation, translate, develop...). Spoiler alert: you don't need to be a coder to help! ## API REST documentation -For now only on Github: +Quick Start: [/support/doc/api/quickstart.md](/support/doc/api/quickstart.md) + +Endpoints documentation: - * HTML version: [/support/doc/api/html/index.html](/support/doc/api/html/index.html) + * 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 .