X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=4a785478c1a8dc261c41fd09061a6b5d0d9e2f2a;hb=d11c28a36b1382ea0a5d5e8d19a67e99b6b24de0;hp=fb8eb0d0e03e4e0f76d07d342da17f4070aa9e50;hpb=f95cb03a29716a455ad89877dfd5192d825e3931;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index fb8eb0d0e..4a785478c 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,21 @@ | Join an instance | Create an instance | Chat with us + | Donate
-Be part of a network of multiple small interconnected, federated, interoperable video hosting providers. Follow video creators and create videos. No vendor lock-in. All on a platform that is community-owned and ad-free. +Be part of a network of multiple small federated, interoperable video hosting providers. Follow video creators and create videos. No vendor lock-in. All on a platform that is community-owned and ad-free. +
+ ++ Developed with ❤ by Framasoft +
+ ++ + +
@@ -34,8 +45,8 @@ Be part of a network of multiple small interconnected, federated, interoperable
-In addition to visitors using WebTorrent to share the load among them, instances can help each other by caching one another's videos. This way even small instances have a way to show content to a wider audience, as they will be shouldered by friend instances (more about that in our redundancy guide).
+In addition to visitors using WebTorrent to share the load among them, instances can help each other by caching one another's videos. This way even small instances have a way to show content to a wider audience, as they will be shouldered by friend instances (more about that in our redundancy guide).
Content creators can get help from their viewers in the simplest way possible: a support button showing a message linking to their donation accounts or really anything else. No more pay-per-view and advertisements that hurt visitors and
-
-
-
-
-
-
-
-
-
-
+
+
@@ -104,7 +115,7 @@ Be it as a user or an instance administrator, you can decide what your experienc
Communities that help each other
incentivize alter creativity (more about that in our FAQ).
@@ -122,7 +133,7 @@ You can also join the cheerful bunch that makes our community:
* 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)**
+ * Matrix (bridged on IRC and [Discord](https://discord.gg/wj8DDUT)) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)**
* Forum:
* Framacolibri: [https://framacolibri.org/c/peertube](https://framacolibri.org/c/peertube)
@@ -136,13 +147,13 @@ Feel free to reach out if you have any questions or ideas! :speech_balloon:
* nginx
* **PostgreSQL >= 9.6**
* **Redis >= 2.8.18**
- * **NodeJS >= 8.x**
+ * **NodeJS >= 10.x**
* **yarn >= 1.x**
* **FFmpeg >= 3.x**
-See the [production guide](/support/doc/production.md), which is the recommended way.
+See the [production guide](/support/doc/production.md), which is the recommended way to install or upgrade PeerTube. For hardware requirements, see [Should I have a big server to run PeerTube?](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md#should-i-have-a-big-server-to-run-peertube) in the FAQ.
-See the [community packages](https://docs.joinpeertube.org/lang/en/docs/install.html), which cover various platforms (including [YunoHost](https://install-app.yunohost.org/?app=peertube) and [Docker](/support/doc/docker.md)).
+See the [community packages](https://docs.joinpeertube.org/#/install-unofficial), which cover various platforms (including [YunoHost](https://install-app.yunohost.org/?app=peertube) and [Docker](/support/doc/docker.md)).
:book: Documentation
----------------------------------------------------------------
@@ -151,13 +162,13 @@ If you have a question, please try to find the answer in the [FAQ](/FAQ.md) firs
### User documentation
-See the [user documentation](https://docs.joinpeertube.org/lang/en/userdocs/).
+See the [user documentation](https://docs.joinpeertube.org/#/use-setup-account).
### Admin documentation
See [how to create your own instance](#package-create-your-own-instance).
-See the more general [admin documentation](https://docs.joinpeertube.org/lang/en/docs/).
+See the more general [admin documentation](https://docs.joinpeertube.org/#/admin-following-instances).
#### Tools
@@ -167,35 +178,13 @@ See the more general [admin documentation](https://docs.joinpeertube.org/lang/en
### Technical documentation
-See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation of the architectural choices.
-
-#### Backend
+See the [architecture blueprint](https://docs.joinpeertube.org/#/contribute-architecture) for a more detailed explanation of the architectural choices.
- * REST API:
- * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml)
- * HTML explorer: [docs.joinpeertube.org/api.html](http://docs.joinpeertube.org/api.html)
- * Servers communicate with each other with [Activity
- Pub](https://www.w3.org/TR/activitypub/).
- * Each server has its own users who query it (search videos, query where the
- torrent URI of this specific video is...).
- * When a user uploads a video, the server sends its followers metadata about the video (name, short description, torrent URI...).
- * 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.
-
-Here are some simple schemes:
-
-