FreakU
/
mastodon
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve README, fix #48

This commit is contained in:
Eugen Rochko 2016-09-21 23:32:53 +02:00
parent c0e9603c92
commit 94525b596a
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -7,7 +7,7 @@ Mastodon
[travis]: https://travis-ci.org/Gargron/mastodon [travis]: https://travis-ci.org/Gargron/mastodon
[code_climate]: https://codeclimate.com/github/Gargron/mastodon [code_climate]: https://codeclimate.com/github/Gargron/mastodon
Mastodon is a federated microblogging engine. An alternative implementation of the GNU Social project. Based on ActivityStreams, Webfinger, PubsubHubbub and Salmon. Mastodon is a federated microblogging engine. An alternative implementation of the GNU social project. Based on ActivityStreams, Webfinger, PubsubHubbub and Salmon.
Focus of the project on a clean REST API and a good user interface. 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. Focus of the project on a clean REST API and a good user interface. 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.
@ -22,19 +22,22 @@ If you would like, you can [support the development of this project on Patreon][
- [API overview](https://github.com/Gargron/mastodon/wiki/API) - [API overview](https://github.com/Gargron/mastodon/wiki/API)
- [How to use the API via cURL/oAuth](https://github.com/Gargron/mastodon/wiki/Testing-with-cURL) - [How to use the API via cURL/oAuth](https://github.com/Gargron/mastodon/wiki/Testing-with-cURL)
## Status ## Features
- GNU Social users can follow Mastodon users - **Fully interoperable with GNU social and any OStatus platform**
- Mastodon users can follow GNU Social users Whatever implements Atom feeds, ActivityStreams, Salmon, PubSubHubbub and Webfinger is part of the network
- Retweets, favourites, mentions, replies work in both directions - **Real-time timeline updates**
- Public pages for profiles and single statuses See the updates of people you're following appear in real-time in the UI via WebSockets
- Sign up, login, forgotten passwords and changing password - **Federated thread resolving**
- Mentions and URLs converted to links in statuses 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
- REST API, including home and mention timelines - **Media attachments like images and WebM**
- OAuth2 provider system for the API Upload and view images and WebM videos attached to the updates
- Upload header image for profile page - **OAuth2 and a straightforward REST API**
- Deleting statuses, deletion propagation Mastodon acts as an OAuth2 provider so 3rd party apps can use the API, which is RESTful and simple
- Real-time timelines via Websockets - **Background processing for long-running tasks**
Mastodon tries to be as fast and responsive as possible, so all long-running tasks that can be delegated to background processing, are
- **Deployable via Docker**
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
## Configuration ## Configuration