Update status in readme
This commit is contained in:
parent
c605b828b5
commit
831a187d74
23
README.md
23
README.md
|
@ -3,15 +3,24 @@ 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.
|
||||||
|
|
||||||
The core ideals of this project are:
|
|
||||||
|
|
||||||
- Independence of legacy Twitter APIs - we don't want to be compatible with Twitter clients, we want our own clients
|
|
||||||
- In that vein, a strong and clean REST API and OAuth2
|
|
||||||
- Minimalism. Just because you can do almost anything with ActivityStreams doesn't mean you should. Limit the set of possible functions to what makes sense in a microblogging engine. This will make federation as well as UI design a lot easier
|
|
||||||
- Ease of deployment. The end-goal of this project is to be distributable as a Docker image.
|
|
||||||
|
|
||||||
**Current status of the project is early development. Documentation, licensing information &co will be added later**
|
**Current status of the project is early development. Documentation, licensing information &co will be added later**
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
- GNU Social users can follow Mastodon users
|
||||||
|
- Mastodon users can follow GNU Social users
|
||||||
|
- Retweets, favourites, mentions, replies work in both directions
|
||||||
|
- Public pages for profiles and single statuses
|
||||||
|
- Sign up, login, forgotten passwords and changing password
|
||||||
|
|
||||||
|
Missing:
|
||||||
|
|
||||||
|
- Media attachments (photos, videos)
|
||||||
|
- Home timeline, notifications timeline
|
||||||
|
- UI to post, reblog, favourite, follow and unfollow
|
||||||
|
- Turn URLs in posts into links
|
||||||
|
- Upload header image for profile page
|
||||||
|
|
||||||
## Configuration
|
## 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_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
|
||||||
|
|
Reference in a new issue