Browse Source

Improve README (#9012)

* Improve README

* Update README.md

* Update README.md

* Update README.md

* Update README.md
Eugen Rochko 1 month ago
parent
commit
3abab56650
No account linked to committer's email address
1 changed files with 39 additions and 42 deletions
  1. 39
    42
      README.md

+ 39
- 42
README.md View File

@@ -1,98 +1,95 @@
1 1
 ![Mastodon](https://i.imgur.com/NhZc40l.png)
2 2
 ========
3 3
 
4
+[![GitHub release](https://img.shields.io/github/release/tootsuite/mastodon.svg)][releases]
4 5
 [![Build Status](https://img.shields.io/circleci/project/github/tootsuite/mastodon.svg)][circleci]
5 6
 [![Code Climate](https://img.shields.io/codeclimate/maintainability/tootsuite/mastodon.svg)][code_climate]
6 7
 [![Translation status](https://weblate.joinmastodon.org/widgets/mastodon/-/svg-badge.svg)][weblate]
8
+[![Docker Pulls](https://img.shields.io/docker/pulls/tootsuite/mastodon.svg)][docker]
7 9
 
10
+[releases]: https://github.com/tootsuite/mastodon/releases
8 11
 [circleci]: https://circleci.com/gh/tootsuite/mastodon
9 12
 [code_climate]: https://codeclimate.com/github/tootsuite/mastodon
10 13
 [weblate]: https://weblate.joinmastodon.org/engage/mastodon/
14
+[docker]: https://hub.docker.com/r/tootsuite/mastodon/
11 15
 
12
-Mastodon is a **free, open-source social network server** based on **open web protocols** like ActivityPub and OStatus. The social focus of the project is a viable decentralized alternative to commercial social media silos that returns the control of the content distribution channels to the people. The technical focus of the project is a good user interface, a clean REST API for 3rd party apps and robust anti-abuse tools.
16
+Mastodon is a **free, open-source social network server** based on ActivityPub. Follow friends and discover new ones. Publish anything you want: links, pictures, text, video. All servers of Mastodon are interoperable as a federated network, i.e. users on one server can seamlessly communicate with users from another one. This includes non-Mastodon software that also implements ActivityPub!
13 17
 
14
-Click on the screenshot below to watch a demo of the UI:
18
+Click below to **learn more** in a video:
15 19
 
16
-[![Screenshot](https://i.imgur.com/qrNOiSp.png)][youtube_demo]
20
+[![Screenshot](https://blog.joinmastodon.org/2018/06/why-activitypub-is-the-future/ezgif-2-60f1b00403.gif)][youtube_demo]
17 21
 
18 22
 [youtube_demo]: https://www.youtube.com/watch?v=IPSbNdBmWKE
19 23
 
20
-**Ruby on Rails** is used for the back-end, while **React.js** and Redux are used for the dynamic front-end. A static front-end for public resources (profiles and statuses) is also provided.
24
+## Navigation 
21 25
 
22
-If you would like, you can [support the development of this project on Patreon][patreon].
26
+- [Project homepage 🐘](https://joinmastodon.org)
27
+- [Support the development via Patreon][patreon]
28
+- [View sponsors](https://joinmastodon.org/sponsors)
29
+- [Blog](https://blog.joinmastodon.org)
30
+- [Documentation](https://docs.joinmastodon.org)
31
+- [Browse Mastodon servers](https://joinmastodon.org/#getting-started)
32
+- [Browse Mastodon apps](https://joinmastodon.org/apps)
23 33
 
24 34
 [patreon]: https://www.patreon.com/mastodon
25 35
 
26
----
27
-
28
-## Resources
29
-
30
-- [Quick start guide](https://blog.joinmastodon.org/2018/08/mastodon-quick-start-guide/)
31
-- [Find Twitter friends on Mastodon](https://bridge.joinmastodon.org)
32
-- [API overview](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md)
33
-- [Documentation](https://github.com/tootsuite/documentation)
34
-- [List of servers](https://joinmastodon.org/#getting-started)
35
-- [List of apps](https://joinmastodon.org/apps)
36
-- [List of sponsors](https://joinmastodon.org/sponsors)
37
-
38 36
 ## Features
39 37
 
38
+<img src="https://docs.joinmastodon.org/elephant.svg" align="right" width="30%" />
39
+
40 40
 **No vendor lock-in: Fully interoperable with any conforming platform**
41 41
 
42
-It doesn't have to be Mastodon, whatever implements ActivityPub or OStatus is part of the social network!
42
+It doesn't have to be Mastodon, whatever implements ActivityPub is part of the social network! [Learn more](https://blog.joinmastodon.org/2018/06/why-activitypub-is-the-future/)
43 43
 
44
-**Real-time timeline updates**
44
+**Real-time, chronological timeline updates**
45 45
 
46 46
 See the updates of people you're following appear in real-time in the UI via WebSockets. There's a firehose view as well!
47 47
 
48
-**Federated thread resolving**
49
-
50
-If someone you follow replies to a user unknown to the server, the server fetches the full thread so you can view it without leaving the UI
51
-
52 48
 **Media attachments like images and short videos**
53 49
 
54 50
 Upload and view images and WebM/MP4 videos attached to the updates. Videos with no audio track are treated like GIFs; normal videos are looped - like vines!
55 51
 
56
-**OAuth2 and a straightforward REST API**
52
+**Safety and moderation tools**
57 53
 
58
-Mastodon acts as an OAuth2 provider so 3rd party apps can use the API
54
+Private posts, locked accounts, phrase filtering, muting, blocking and all sorts of other features, along with a reporting and moderation system. [Learn more](https://blog.joinmastodon.org/2018/07/cage-the-mastodon/)
59 55
 
60
-**Fast response times**
56
+**OAuth2 and a straightforward REST API**
61 57
 
62
-Mastodon tries to be as fast and responsive as possible, so all long-running tasks are delegated to background processing
58
+Mastodon acts as an OAuth2 provider so 3rd party apps can use the REST and Streaming APIs, resulting in a rich app ecosystem with a lot of choice!
63 59
 
64
-**Deployable via Docker**
60
+## Deployment
65 61
 
66
-You don't need to mess with dependencies and configuration if you want to try Mastodon, if you have Docker and Docker Compose the deployment is extremely easy
62
+**Tech stack:**
67 63
 
68
----
64
+- **Ruby on Rails** powers the REST API and other web pages
65
+- **React.js** and Redux are used for the dynamic parts of the interface
66
+- **Node.js** powers the streaming API
69 67
 
70
-## Development
68
+**Requirements:**
71 69
 
72
-Please follow the [development guide](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Development-guide.md) from the documentation repository.
70
+- **PostgreSQL** 9.5+
71
+- **Redis**
72
+- **Ruby** 2.4+
73
+- **Node.js** 8+
73 74
 
74
-## Deployment
75
+The repository includes deployment configurations for **Docker and docker-compose**, but also a few specific platforms like **Heroku**, **Scalingo**, and **Nanobox**. The [**stand-alone** installation guide](https://docs.joinmastodon.org/administration/installation/) is available in the documentation.
75 76
 
76
-There are guides in the documentation repository for [deploying on various platforms](https://github.com/tootsuite/documentation#running-mastodon).
77
+A **Vagrant** configuration is included for development purposes.
77 78
 
78 79
 ## Contributing
79 80
 
80
-You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository. [Here are the guidelines for code contributions](CONTRIBUTING.md)
81
+Mastodon is **free, open source software** licensed under **AGPLv3**.
82
+
83
+You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository, or submit translations using Weblate. To get started, take a look at [CONTRIBUTING.md](CONTRIBUTING.md)
81 84
 
82 85
 **IRC channel**: #mastodon on irc.freenode.net
83 86
 
84 87
 ## License
85 88
 
86
-Copyright (C) 2016-2018 Eugen Rochko & other Mastodon contributors (see AUTHORS.md)
89
+Copyright (C) 2016-2018 Eugen Rochko & other Mastodon contributors (see [AUTHORS.md](AUTHORS.md))
87 90
 
88 91
 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 by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
89 92
 
90 93
 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
91 94
 
92 95
 You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
93
-
94
----
95
-
96
-## Extra credits
97
-
98
-The elephant friend illustrations are created by [Dopatwo](https://mastodon.social/@dopatwo)