diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 45 |
1 files changed, 24 insertions, 21 deletions
@@ -1,13 +1,13 @@ | |||
1 | <h1 align="center"> | 1 | <h1 align="center"> |
2 | <a href="https://joinpeertube.org"> | 2 | <a href="https://joinpeertube.org"> |
3 | <img src="https://joinpeertube.org/img/brand.png" alt="PeerTube"> | 3 | <img src="https://joinpeertube.org/img/brand.png" alt="PeerTube"> |
4 | <a> | 4 | </a> |
5 | </h1> | 5 | </h1> |
6 | 6 | ||
7 | <p align=center> | 7 | <p align=center> |
8 | <strong><a href="https://joinpeertube.org">Website</a></strong> | 8 | <strong><a href="https://joinpeertube.org">Website</a></strong> |
9 | | <strong><a href="https://instances.joinpeertube.org">Join an instance</a></strong> | 9 | | <strong><a href="https://instances.joinpeertube.org">Join an instance</a></strong> |
10 | | <strong><a href="#package-create-your-own-instance">Create one</a></strong> | 10 | | <strong><a href="#package-create-your-own-instance">Create an instance</a></strong> |
11 | | <strong><a href="#contact">Chat with us</a></strong> | 11 | | <strong><a href="#contact">Chat with us</a></strong> |
12 | </p> | 12 | </p> |
13 | 13 | ||
@@ -75,7 +75,7 @@ Just upload your videos, and be sure they will stream anywhere. Add a descriptio | |||
75 | 75 | ||
76 | <h3 align="right">Keep in touch with video creators</h3> | 76 | <h3 align="right">Keep in touch with video creators</h3> |
77 | <p align="right"> | 77 | <p align="right"> |
78 | 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. | 78 | 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. |
79 | </p> | 79 | </p> |
80 | 80 | ||
81 | --- | 81 | --- |
@@ -121,6 +121,24 @@ enough because one video could become popular and overload the server. That is | |||
121 | why we need to use a P2P protocol to limit the server load. Thanks to | 121 | why we need to use a P2P protocol to limit the server load. Thanks to |
122 | [WebTorrent](https://github.com/feross/webtorrent), we can make BitTorrent inside the web browser, as of today. | 122 | [WebTorrent](https://github.com/feross/webtorrent), we can make BitTorrent inside the web browser, as of today. |
123 | 123 | ||
124 | :raised_hands: Contributing | ||
125 | ---------------------------------------------------------------- | ||
126 | |||
127 | You don't need to be a coder to help! | ||
128 | |||
129 | You can give us your feedback, report bugs, help us translate PeerTube, write documentation, and more. Check out the [contributing | ||
130 | guide](/.github/CONTRIBUTING.md) to know how, it takes less than 2 minutes to get started. :wink: | ||
131 | |||
132 | You can also join the cheerful bunch that makes our community: | ||
133 | |||
134 | * Chat<a name="contact"></a>: | ||
135 | * IRC : **[#peertube on chat.freenode.net:6697](https://kiwiirc.com/client/irc.freenode.net/#peertube)** | ||
136 | * Matrix (bridged on the IRC channel) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)** | ||
137 | * Forum: | ||
138 | * Framacolibri: [https://framacolibri.org/c/peertube](https://framacolibri.org/c/peertube) | ||
139 | |||
140 | Feel free to reach out if you have any questions or ideas! :speech_balloon: | ||
141 | |||
124 | :package: Create your own instance | 142 | :package: Create your own instance |
125 | ---------------------------------------------------------------- | 143 | ---------------------------------------------------------------- |
126 | 144 | ||
@@ -137,20 +155,6 @@ See the [production guide](/support/doc/production.md), which is the recommended | |||
137 | 155 | ||
138 | 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)). | 156 | 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)). |
139 | 157 | ||
140 | :wrench: Contribute/Translate/Test | ||
141 | ---------------------------------------------------------------- | ||
142 | |||
143 | *Spoiler alert*: you don't need to be a coder to help! | ||
144 | |||
145 | See the [contributing | ||
146 | guide](/.github/CONTRIBUTING.md). Or simply join the cheerful bunch that makes our community: | ||
147 | |||
148 | * Chat<a name="contact"></a>: | ||
149 | * IRC : **[#peertube on chat.freenode.net:6697](https://kiwiirc.com/client/irc.freenode.net/#peertube)** | ||
150 | * Matrix (bridged on the IRC channel) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)** | ||
151 | * Forum: | ||
152 | * Framacolibri: [https://framacolibri.org/c/peertube](https://framacolibri.org/c/peertube) | ||
153 | |||
154 | :book: Documentation | 158 | :book: Documentation |
155 | ---------------------------------------------------------------- | 159 | ---------------------------------------------------------------- |
156 | 160 | ||
@@ -179,9 +183,8 @@ See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation of the a | |||
179 | #### Backend | 183 | #### Backend |
180 | 184 | ||
181 | * REST API: | 185 | * REST API: |
182 | * Quick Start: [/support/doc/api/quickstart.md](/support/doc/api/quickstart.md) | 186 | * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml) |
183 | * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml) | 187 | * HTML explorer: [docs.joinpeertube.org/api.html](http://docs.joinpeertube.org/api.html) |
184 | * HTML explorer: [/support/doc/api/html/index.html](https://htmlpreview.github.io/?https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/html/index.html) | ||
185 | * Servers communicate with each other with [Activity | 188 | * Servers communicate with each other with [Activity |
186 | Pub](https://www.w3.org/TR/activitypub/). | 189 | Pub](https://www.w3.org/TR/activitypub/). |
187 | * Each server has its own users who query it (search videos, query where the | 190 | * Each server has its own users who query it (search videos, query where the |