X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=f3a754d54652ae5b2ba6296af5084ab86697845e;hb=82815eb6700332b2fb41bcbbf2224471f66bb5a0;hp=10ed7e21a6b19ee3c7f19306048d002784913b2b;hpb=c27c3a27a3c032a56f22ddf528393c35646a49cd;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 10ed7e21a..f3a754d54 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ directly in the web browser with **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 them](https://soutenir.framasoft.org/en/).** +donating to them](https://soutenir.framasoft.org/en/).**

Client @@ -65,11 +65,13 @@ donating them](https://soutenir.framasoft.org/en/).** Want to see it in action? * Demonstration servers: - * [peertube.cpy.re](http://peertube.cpy.re) - * [peertube2.cpy.re](http://peertube2.cpy.re) + * [peertube.cpy.re](http://peertube.cpy.re) + * [peertube2.cpy.re](http://peertube2.cpy.re) * [peertube3.cpy.re](http://peertube3.cpy.re) * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504) - to see how the "decentralization feature" looks like + to see what the "decentralization feature" looks like + +*Currently PeerTube is still in alpha (we plan to release a beta in march). Demonstration servers do not support public registration. If you really want to test PeerTube before the public release, here is a list of PeerTube servers: https://github.com/Chocobozzz/PeerTube/wiki#other-peertube-servers.* ## Why @@ -131,14 +133,19 @@ BitTorrent) inside the web browser, as of today. * nginx * PostgreSQL + * Redis * **NodeJS >= 8.x** * yarn * OpenSSL (cli) * FFmpeg +## Run using Docker + +See the [docker guide](/support/doc/docker.md) + ## Production -See the [production guide](support/doc/production.md). +See the [production guide](/support/doc/production.md). ## Contributing @@ -147,6 +154,13 @@ guide](/.github/CONTRIBUTING.md) to see how to contribute to PeerTube. Spoiler alert: you don't need to be a coder to help! +## API REST documentation + +For now only on Github: + + * HTML version: [/support/doc/api/html/index.html](/support/doc/api/html/index.html) + * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml) + ## Architecture See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.