X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=0c2989c62fd0b3559ac620706f0bd9ffa314f3d1;hb=ffc424259ebe5d670136d6c6183f3d65632655a5;hp=ae78b4893489308707508674904e4181c16c591e;hpb=9bb720f3f96d781d5e132220ace4515e779cea3c;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index ae78b4893..0c2989c62 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@

Website - | Join an instance - | Create an instance - | Chat with us + | Join an instance + | Create an instance + | Chat with us | Donate

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

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

- screenshot + screenshot

@@ -67,28 +67,32 @@ Introduction PeerTube is a free, decentralized and federated video platform developed as an alternative to other platforms that centralize our data and attention, such as YouTube, Dailymotion or Vimeo. :clapper: -But one organization hosting PeerTube alone may not have enough money to pay for bandwidth and video storage of its servers, -all servers of PeerTube are interoperable as a federated network, and non-PeerTube servers can be part of the larger Vidiverse -(federated video network) by talking our implementation of ActivityPub. -Video load is reduced thanks to P2P in the web browser using WebTorrent or p2p-media-loader. - -To learn more, see: +To learn more: * This [two-minute video](https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3) (hosted on PeerTube) explaining what PeerTube is and how it works * PeerTube's project homepage, [joinpeertube.org](https://joinpeertube.org) * Demonstration instances: - * [peertube.cpy.re](https://peertube.cpy.re) - * [peertube2.cpy.re](https://peertube2.cpy.re) - * [peertube3.cpy.re](https://peertube3.cpy.re) + * [peertube.cpy.re](https://peertube.cpy.re) (stable) + * [peertube2.cpy.re](https://peertube2.cpy.re) (Nightly) + * [peertube3.cpy.re](https://peertube3.cpy.re) (RC) * This [video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) demonstrating the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon) (a decentralized Twitter alternative) :sparkles: Features ---------------------------------------------------------------- +

+ All features for viewers + | All features for content creators + | All features for administrators +

+ -

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! +

--- @@ -112,16 +116,18 @@ 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). +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 alter creativity (more about that in our FAQ).

+ + :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: @@ -129,8 +135,8 @@ guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING. 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 IRC and [Discord](https://discord.gg/wj8DDUT)) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)** + * IRC : **[#peertube on irc.libera.chat:6697](https://web.libera.chat/#peertube)** * Forum: * Framacolibri: [https://framacolibri.org/c/peertube](https://framacolibri.org/c/peertube) @@ -139,42 +145,48 @@ Feel free to reach out if you have any questions or ideas! :speech_balloon: :package: Create your own instance ---------------------------------------------------------------- -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 [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://joinpeertube.org/faq#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 ---------------------------------------------------------------- -If you have a question, please try to find the answer in the [FAQ](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md) first. +If you have a question, please try to find the answer in the [FAQ](https://joinpeertube.org/faq) first. ### 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-2021 PeerTube Contributors (see [CREDITS.md](CREDITS.md)) +### Logo + +[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/), by [Framasoft](https://framasoft.org) + +### Code + +Copyright (C) 2015-2023 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 @@ -187,4 +199,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 .