Fix static avatars/thumbnails cache

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

diff --git a/README.md b/README.md
index 8abdaf67d458d43d76b975965f37edf82586df45..451e6612c9fe486b90ea383668b47e4314707833 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,15 +2,14 @@
   PeerTube
 </h1>
 
   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>.
 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 developed by [Framasoft](https://framasoft.org/?l=en), a non-profit
-that promotes and spreads 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 have run <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. Thanks to everyone who pitched in and shared the news around. You can now check out <a href="https://github.com/Chocobozzz/PeerTube/milestone/1">the corresponding milestone</a> and help its development!</strong>
+</p>

 
 <p align="center">
   <strong>Client</strong>
 
 <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://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">
 </p>
 
 <p align="center">


@@ -46,10 +49,6 @@ donating to them](https://soutenir.framasoft.org/en/).**
   <a href="http://standardjs.com/">
     <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
   </a>
   <a href="http://standardjs.com/">
     <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
   </a>

-
-  <a href="https://kiwiirc.com/client/irc.freenode.net/#peertube">
-    <img src="https://img.shields.io/badge/%23peertube-on%20freenode-brightgreen.svg" alt="PeerTube Freenode IRC" />
-  </a>

 </p>
 
 <br />
 </p>
 
 <br />


@@ -60,20 +59,23 @@ donating to them](https://soutenir.framasoft.org/en/).**
   </a>
 </p>
 
   </a>
 </p>
 

-<p align="center">
-  <strong><a title="Website" target="_blank" href="https://joinpeertube.org">Website</a> |
-  <a title="Instances list" target="_blank" href="https://instances.joinpeertube.org">Instances list</a>
-  </strong>
-</p>
+## Getting Started
+
+  * **[Website](https://joinpeertube.org)**
+  * **[Instances list](https://instances.joinpeertube.org)**
+  * Chat:
+    * IRC : **[#peertube on chat.freenode.net:6697](https://kiwiirc.com/client/irc.freenode.net/#peertube)**
+    * Matrix (bridged on the IRC channel) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)**

 
 ## Demonstration
 
 Want to see it in action?
 
    * Demonstration servers:
 
 ## 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
    * [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


@@ -87,8 +89,8 @@ enough money to pay for bandwidth and video storage of its servers.
 
 So we need to have a decentralized network of servers seeding videos (as
 [Diaspora](https://github.com/diaspora/diaspora) for example).  But it's not
 
 So we need to have a decentralized network of servers seeding videos (as
 [Diaspora](https://github.com/diaspora/diaspora) for example).  But it's not

-enough because one video could become famous and overload the server.  It's the
-reason why we need to use a P2P protocol to limit the server load.  Thanks to
+enough because one video could become famous and overload the server.  That is 
+why we need to use a P2P protocol to limit the server load.  Thanks to

 [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus
 BitTorrent) inside the web browser, as of today.
 
 [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus
 BitTorrent) inside the web browser, as of today.
 


@@ -102,19 +104,24 @@ BitTorrent) inside the web browser, as of today.
   * OpenSSL (cli)
   * **FFmpeg >= 3.x**
 
   * OpenSSL (cli)
   * **FFmpeg >= 3.x**
 

-## Run using Docker
+## Run in production
+
+See the [production guide](/support/doc/production.md).

 
 

-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)

 
 

-## Production
+Peertube app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/peertube_ynh).

 
 

-See the [production guide](/support/doc/production.md).
+## Run using Docker
+
+See the [docker guide](/support/doc/docker.md).

 
 

-## Contributing/Test
+## Contribute/Translate/Test

 
 See the [contributing
 guide](/.github/CONTRIBUTING.md)
 
 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
 coder to help!
 
 ## API REST documentation


@@ -130,6 +137,7 @@ Endpoints documentation:
 
  * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md)
  * [Upload videos from the CLI](/support/doc/tools.md)
 
  * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md)
  * [Upload videos from the CLI](/support/doc/tools.md)

+ * [Admin server tools (create transcoding jobs, prune storage...)](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/tools.md#server-tools)

 
 ## FAQ
 
 
 ## FAQ
 


@@ -148,7 +156,7 @@ See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.
     torrent URI of this specific video is...).
   * If a user uploads a video, the server seeds it and sends its followers some
     metadata (name, short description, torrent URI...).
     torrent URI of this specific video is...).
   * If a user uploads a video, the server seeds it and sends its followers some
     metadata (name, short description, torrent URI...).

-  * A server is a tracker responsible for all the videos uploaded in it.
+  * A server is a tracker responsible for all the videos uploaded on it.

   * Even if nobody watches a video, it is seeded by the server (through
     [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the
     video was uploaded.
   * Even if nobody watches a video, it is seeded by the server (through
     [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the
     video was uploaded.


@@ -171,7 +179,7 @@ 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
 
 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
+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,
 (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,