From 3f82804c6cc26a3a67e28d5404d5e5605a6fa4a6 Mon Sep 17 00:00:00 2001 From: Rigel Kent Date: Fri, 23 Nov 2018 18:02:08 +0100 Subject: add donate link, move redundancy doc and images to docs.joinpeertube.org --- README.md | 37 ++++++++----------------------------- 1 file changed, 8 insertions(+), 29 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index fb8eb0d0e..a3669353b 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,11 @@ | 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.

@@ -104,7 +105,7 @@ Be it as a user or an instance administrator, you can decide what your experienc

Communities that help each other

-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 incentivize alter creativity (more about that in our FAQ). @@ -167,35 +168,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. +See the [architecture blueprint](https://docs.joinpeertube.org/lang/en/devdocs/architecture.html) for a more detailed explanation of the architectural choices. -#### Backend - - * 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: - -

- -Decentralized - -Watch a video - -Watch a P2P video - -

+See our REST API documentation: + * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml) + * Spec explorer: [docs.joinpeertube.org/api.html](http://docs.joinpeertube.org/api.html) +See our [ActivityPub documentation](https://docs.joinpeertube.org/lang/en/devdocs/federation.html). :heart: Supports of our crowdfunding ---------------------------------------------------------------- -- cgit v1.2.3