X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=95f274b7b652effd43d7d49f6cc148f89a9ea0c3;hb=266707202c2ffcb8a1b7649ec29106dd444f4a77;hp=b37d79e554f7ba16b8bf85c4446df491fb5df267;hpb=afe817679974cec47f5bea1699cee3fe58cd5ada;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index b37d79e55..95f274b7b 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 @@ -21,7 +21,7 @@ donating them](https://soutenir.framasoft.org/en/).** Dependency Status - + devDependency Status

@@ -39,7 +39,7 @@ donating them](https://soutenir.framasoft.org/en/).** Dependencies Status - + devDependency Status @@ -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,22 +133,38 @@ 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 +## Contributing/Test See the [contributing guide](/.github/CONTRIBUTING.md) -to see how to contribute to PeerTube. Spoiler alert: you don't need to be a +to see how to test or 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) + +## Tools + + * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/import-videos.md) + ## Architecture See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.