about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorEugen Rochko <eugen@zeonfederated.com>2016-03-12 20:47:22 +0100
committerEugen Rochko <eugen@zeonfederated.com>2016-03-12 20:47:22 +0100
commit34413615683677e26213263fb98f63b5aab64872 (patch)
tree7e682e8709ecfd5347316ea39240789548795606 /README.md
parent1aa477ac2f0e9195497899691bb5cc16a7034c01 (diff)
Adding simple_form, adding profile settings, header image
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/README.md b/README.md
index 2b03dee48..273d1a1b3 100644
--- a/README.md
+++ b/README.md
@@ -13,17 +13,24 @@ Mastodon is a federated microblogging engine. An alternative implementation of t
 - Public pages for profiles and single statuses
 - Sign up, login, forgotten passwords and changing password
 - Mentions and URLs converted to links in statuses
+- REST API, including home and mention timelines
+- OAuth2 provider system for the API
 
 Missing:
 
 - Media attachments (photos, videos)
-- Home timeline, notifications timeline
 - UI to post, reblog, favourite, follow and unfollow
 - Upload header image for profile page
 - Deleting statuses, deletion propagation
+- Streaming API
 
 ## Configuration
 
 - `LOCAL_DOMAIN` should be the domain/hostname of your instance. This is **absolutely required** as it is used for generating unique IDs for everything federation-related
 - `LOCAL_HTTPS` set it to `true` if HTTPS works on your website. This is used to generate canonical URLs, which is also important when generating and parsing federation-related IDs
 - `HUB_URL` should be the URL of the PubsubHubbub service that your instance is going to use. By default it is the open service of Superfeedr
+
+## Requirements
+
+- PostgreSQL
+- Redis