Fix video_share_url duplicate key in transcoding job

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

diff --git a/README.md b/README.md
index b37d79e554f7ba16b8bf85c4446df491fb5df267..0802662cb0fc28bd5a9e85cd6a26cc3c01be56bb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ directly in the web browser with <a href="https://github.com/feross/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 them](https://soutenir.framasoft.org/en/).**
+donating to them](https://soutenir.framasoft.org/en/).**
 
 <p align="center">
   <strong>Client</strong>
@@ -21,7 +21,7 @@ donating them](https://soutenir.framasoft.org/en/).**
     <img src="https://david-dm.org/Chocobozzz/PeerTube.svg?path=client" alt="Dependency Status" />
   </a>
 
-  <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client#info=dev">
+  <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>
 </p>
@@ -39,7 +39,7 @@ donating them](https://soutenir.framasoft.org/en/).**
     <img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" />
   </a>
 
-  <a href="https://david-dm.org/Chocobozzz/PeerTube#info=dev">
+  <a href="https://david-dm.org/Chocobozzz/PeerTube?type=dev">
     <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
   </a>
 
@@ -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
 
@@ -114,6 +116,8 @@ BitTorrent) inside the web browser, as of today.
 - [X] Video privacy settings (public, unlisted or private)
 - [X] Signaling a video to the admin origin PeerTube instance
 - [X] Federated videos comments
+- [X] Update video thumbnails
+- [X] Support video uploader button
 - [ ] Video imports (URL, Torrent, YouTube...)
 - [ ] Advanced search
 - [ ] Subtitles
@@ -131,22 +135,43 @@ BitTorrent) inside the web browser, as of today.
 
   * nginx
   * PostgreSQL
+  * Redis
   * **NodeJS >= 8.x**
   * yarn
   * OpenSSL (cli)
-  * FFmpeg
+  * **FFmpeg >= 3.x**
+
+## 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/tools.md)
+ * [Upload videos from the CLI](/support/doc/tools.md)
+
+## FAQ
+
+If you have a question, please try to find the answer in the [FAQ](/FAQ.md) first.
+
 ## Architecture
 
 See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.