X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=cfd44f560a1d105e1bcd10c83f3d4216d794abcf;hb=890666733f3f2d0f9f1f8cb89c54fee555ac5715;hp=202d6680de52f714445628c51d48f5cb3fb3e0bb;hpb=e8395f027b6c3e3f757c740e35b20e76c51b03bd;p=github%2FChocobozzz%2FPeerTube.git
diff --git a/README.md b/README.md
index 202d6680d..cfd44f560 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,59 @@
+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:
+
+
+
+ Developed with ❤ by Framasoft
+
+
+
+
+
+
+
+
+ Client
+
+
+
+
+
+
+
+
+
+
@@ -31,8 +61,8 @@ donating to them](https://soutenir.framasoft.org/en/).**
-
-
+
+
@@ -46,163 +76,147 @@ donating to them](https://soutenir.framasoft.org/en/).**
-
-
-
-
-
-
+
+
-## Demonstration
-
-Want to see it in action?
-
- * Demonstration servers:
- * [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 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
-
-We can't build a FOSS video streaming alternatives to YouTube, Dailymotion,
-Vimeo... with a centralized software. One organization alone may not have
-enough money to pay for bandwidth and video storage of its servers.
-
-So we need to have a decentralized network of servers seeding videos (as
-[Diaspora](https://github.com/diaspora/diaspora) for example). But it's not
-enough because one video could become famous and overload the server. It's the
-reason why we need to use a P2P protocol to limit the server load. Thanks to
-[WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus
-BitTorrent) inside the web browser, as of today.
+Introduction
+----------------------------------------------------------------
-## Features
-
-- [X] Angular frontend
-- [X] Join the fediverse
- - [X] Follow other instances
- - [X] Unfollow an instance
- - [X] Get for the followers/following list
-- [X] Upload a video
- - [X] Seed the video
- - [X] Send the meta data with ActivityPub to followers
-- [X] Remove the video
-- [X] List the videos
-- [X] View the video in an HTML5 player with WebTorrent
-- [X] Admin panel
-- [X] OpenGraph tags
-- [X] OEmbed
-- [X] Update video
-- [X] Federated videos view counter
-- [X] Federated videos likes/dislikes
-- [X] Transcoding to different definitions
-- [X] Download file/torrent
-- [X] User video bytes quota
-- [X] User video channels
-- [X] NSFW warnings/settings
-- [X] Video description in markdown
-- [X] User roles (administrator, moderator)
-- [X] User registration
-- [X] Video privacy settings (public, unlisted or private)
-- [X] Signaling a video to the admin origin PeerTube instance
-- [X] Federated videos comments
-- [ ] Video imports (URL, Torrent, YouTube...)
-- [ ] Advanced search
-- [ ] Subtitles
-- [ ] User playlist
-- [ ] User subscriptions (by tags, author...)
-- [ ] Add "DDOS" security
-
-
-## Front compatibility
-
- * Firefox
- * Chrome/Chromium
-
-## Dependencies
-
- * nginx
- * PostgreSQL
- * Redis
- * **NodeJS >= 8.x**
- * yarn
- * OpenSSL (cli)
- * FFmpeg
-
-## Run using Docker
-
-You can quickly get a server running using Docker. You need to have [docker](https://www.docker.com/community-edition) and [docker-compose](https://docs.docker.com/compose/install/) installed.
-
-For this example configuration, you should also run a reverse proxy. The example
-Docker Compose file provides example labels for the Traefik load balancer,
-though any HTTP reverse proxy is compatible.
-
-Example for running a peertube server locally:
-
-```bash
-sudo \
- PEERTUBE_HOSTNAME=peertube.lvh.me \
- PEERTUBE_ADMIN_EMAIL=test@example.com \
- PEERTUBE_TRANSCODING_ENABLED=true \
- docker-compose up app
-```
-
-(Get the initial root user password from the program output.)
-
-## Production
-
-See the [production guide](support/doc/production.md).
-
-## Contributing
-
-See the [contributing
-guide](/.github/CONTRIBUTING.md)
-to see how to 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)
-
-## Architecture
-
-See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.
-
-### Backend
-
- * The backend is a REST API.
- * Servers communicate with each others 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...).
- * If a user uploads a video, the server seeds it and sends its followers some
- metadata (name, short description, torrent URI...).
- * A server is a tracker responsible for all the videos uploaded in 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:
+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:
+* 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)
+* 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
+----------------------------------------------------------------
+
+
+
Video streaming
+
+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!
+
+
+---
+
+
+
+Keep in touch with video creators
+
+Follow your favorite channels from PeerTube or really any other place. No need to have an account on the instance you watched a video to follow its author, you can do all of that from the Fediverse (Mastodon, Pleroma, and plenty others), or just with good ol' RSS.
+
-
+---
-
+
+An interface to call home
+
+Be it as a user or an instance administrator, you can decide what your experience will be like. Don't like the colors? They are easy to change. Don't want to list videos of an instance but let your users subscribe to them? Don't like the regular web client? All of that can be changed, and much more. No UX dark pattern, no mining your data, no video recommendation bullshitâ¢.
+
+---
+
+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).
+
+
+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).
+
+
+:raised_hands: Contributing
+----------------------------------------------------------------
+
+You don't need to be a coder 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:
+
+You can also join the cheerful bunch that makes our community:
+
+* Chat