X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=377794a0aeeaeebf6c5fc5c4a81a6e9c5144712d;hb=c11fc2d9de28b7de30fa970b2c481f598b65098f;hp=c27f61f704ab7853f08bfcb89c63fe087e146108;hpb=63703d8cee3e6c45c9ae02050df6dc0f66b4737b;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index c27f61f70..377794a0a 100644 --- a/README.md +++ b/README.md @@ -16,18 +16,6 @@ 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.

-

-:rocket::rocket::rocket: -

- -

-Check, share and support PeerTube's v3 roadmap on https://joinpeertube.org/roadmap -

- -

-:rocket: :rocket: :rocket: -

-

Developed with ❤ by Framasoft

@@ -43,8 +31,8 @@ Be part of a network of multiple small federated, interoperable video hosting pr
- - + + @@ -61,7 +49,7 @@ Be part of a network of multiple small federated, interoperable video hosting pr test suite status - + JavaScript Style Guide

@@ -70,7 +58,7 @@ Be part of a network of multiple small federated, interoperable video hosting pr

- screenshot + screenshot

@@ -97,10 +85,13 @@ To learn more, see: ---------------------------------------------------------------- -

Video streaming

+

Video streaming, even in live!

Just upload your videos, and be sure they will stream anywhere. Add a description, some tags and your video will be discoverable by the entire video fediverse, not just your instance. You can even embed a player on your favorite website!

+

+You are used to hosting live events? We got you covered too! Start livestreaming from your favorite client, and even host permanent streams! +

--- @@ -124,7 +115,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). @@ -133,7 +124,7 @@ Content creators can get help from their viewers in the simplest way possible: a :raised_hands: Contributing ---------------------------------------------------------------- -You don't need to be a coder to help! +You don't need to be a programmer to help! You can give us your feedback, report bugs, help us translate PeerTube, write documentation, and more. Check out the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md) to know how, it takes less than 2 minutes to get started. :wink: @@ -153,7 +144,7 @@ Feel free to reach out if you have any questions or ideas! :speech_balloon: See the [production guide](https://github.com/Chocobozzz/PeerTube/blob/develop/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/#/install-unofficial), which cover various platforms (including [YunoHost](https://install-app.yunohost.org/?app=peertube) and [Docker](https://github.com/Chocobozzz/PeerTube/blob/develop/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](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/docker.md)). :book: Documentation ---------------------------------------------------------------- @@ -162,31 +153,31 @@ If you have a question, please try to find the answer in the [FAQ](https://githu ### User documentation -See the [user documentation](https://docs.joinpeertube.org/#/use-setup-account). +See the [user documentation](https://docs.joinpeertube.org/use-setup-account). ### Admin documentation See [how to create your own instance](https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance). -See the more general [admin documentation](https://docs.joinpeertube.org/#/admin-following-instances). +See the more general [admin documentation](https://docs.joinpeertube.org/admin-following-instances). ### Tools documentation -Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/#/maintain-tools). +Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/maintain-tools). ### Technical documentation -See the [architecture blueprint](https://docs.joinpeertube.org/#/contribute-architecture) for a more detailed explanation of the architectural choices. +See the [architecture blueprint](https://docs.joinpeertube.org/contribute-architecture) for a more detailed explanation of the architectural choices. See our REST API documentation: * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml) * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html) -See our [ActivityPub documentation](https://docs.joinpeertube.org/#/api-activitypub). +See our [ActivityPub documentation](https://docs.joinpeertube.org/api-activitypub). ## License -Copyright (C) 2015-2020 PeerTube Contributors (see [CREDITS.md](CREDITS.md)) +Copyright (C) 2015-2021 PeerTube Contributors (see [CREDITS.md](CREDITS.md)) 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 @@ -199,4 +190,4 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License -along with this program. If not, see . +along with this program. If not, see .