diff options
| author | Eugen <eugen@zeonfederated.com> | 2016-09-02 14:07:21 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-09-02 14:07:21 +0200 |
| commit | f24cb32e99afdb9fa31067fb647912fec92e9ed4 (patch) | |
| tree | 5c192848c2452d9fcddf4cae4dc2fc47567c7c7a /README.md | |
| parent | 2d57bcf1b7ea3a9df42ae7e1eb9388f978a96312 (diff) | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md index 86fb450bc..4de35a090 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,18 @@ Mastodon Mastodon is a federated microblogging engine. An alternative implementation of the GNU Social project. Based on ActivityStreams, Webfinger, PubsubHubbub and Salmon. -**Current status of the project is early development. Documentation &co will be added later** +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. + +If you would like, you can [support the development of this project on Patreon][patreon]. + +[patreon]: https://www.patreon.com/user?u=619786 + +**Current status of the project is early development** + +## Resources + +- [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) ## Status @@ -23,6 +34,7 @@ Mastodon is a federated microblogging engine. An alternative implementation of t - OAuth2 provider system for the API - Upload header image for profile page - Deleting statuses, deletion propagation +- Real-time timelines via Websockets ## Configuration |