Add translation guide

[github/Chocobozzz/PeerTube.git] / README.md

diff --git a/README.md b/README.md
index 4d83ea8469e39e3792cc402798f112cec32a8a97..09ab9fdc1054eb2848eb2c2da8893b413283ad79 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,15 +2,14 @@
   PeerTube
 </h1>
 
-<h4 align="center">
+<p align="center">
 Federated (ActivityPub) video streaming platform using P2P (BitTorrent)
 directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
-</h4>
+</p>
 
-**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/).**
+<p align="center">
+<strong>We are running <a href="https://www.kisskissbankbank.com/en/projects/peertube-a-free-and-federated-video-platform">a crowdfunding campaign</a> to pave the road to version 1.0 of PeerTube!</strong>
+</p>
 
 <p align="center">
   <strong>Client</strong>
@@ -24,6 +23,10 @@ donating to them](https://soutenir.framasoft.org/en/).**
   <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client&type=dev">
     <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" />
   </a>
+  
+  <a href="https://www.browserstack.com/automate/public-build/VXBPc0szNjUvRUNsREJQRFF6RkEvSjJBclZ4VUJBUm1hcS9RZGpUbitRST0tLWFWbjNEdVN6eEZpYTk4dGVpMkVlQWc9PQ==--644e755052bf7fe2346eb6e868be8e706718a17c%">
+    <img src='https://www.browserstack.com/automate/badge.svg?badge_key=VXBPc0szNjUvRUNsREJQRFF6RkEvSjJBclZ4VUJBUm1hcS9RZGpUbitRST0tLWFWbjNEdVN6eEZpYTk4dGVpMkVlQWc9PQ==--644e755052bf7fe2346eb6e868be8e706718a17c%'/>
+  </a>
 </p>
 
 <p align="center">
@@ -60,6 +63,11 @@ donating to them](https://soutenir.framasoft.org/en/).**
   </a>
 </p>
 
+## Getting Started
+
+  * **[Website](https://joinpeertube.org)**
+  * **[Instances list](https://instances.joinpeertube.org)**
+
 ## Demonstration
 
 Want to see it in action?
@@ -70,6 +78,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,22 +108,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