diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 28 insertions, 7 deletions
diff --git a/README.md b/README.md index 470e379dc..502e0d8db 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,33 @@ -# Mastodon Glitch Edition # + +======== -> Now with automated deploys! +[](https://hub.docker.com/repository/docker/pluralcafe/mastodon) [](https://plural.cafe) -[][circleci] +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. -[circleci]: https://circleci.com/gh/glitch-soc/mastodon +**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. -So here's the deal: we all work on this code, and then it runs on dev.glitch.social and anyone who uses that does so absolutely at their own risk. can you dig it? +This repository specifically is for [Plural Café](https://plural.cafe) and has three branches: -- You can view documentation for this project at [glitch-soc.github.io/docs/](https://glitch-soc.github.io/docs/). -- And contributing guidelines are available [here](CONTRIBUTING.md) and [here](https://glitch-soc.github.io/docs/contributing/). +* **main** (**edge** on Docker Hub) for all development and staging work, +* **glitch** for all commits from upstream that will automatically be synched to this repository, and +* **production** (**latest** on Docker Hub) for what goes onto the main website. + +In addition, there are several repositories in this GitHub organization: + +* **pluralcafe/mastodon** is this repository and is the codebase for what Plural Café runs, +* [**pluralcafe/utils**](https://github.com/pluralcafe/utils) are an assortment of scripts and tutorials to help in Mastodon system administration or general helper files this instance uses, +* [**pluralcafe/barkeep**](https://github.com/pluralcafe/barkeep) is forked from [mbilokonsky/ambassador](https://github.com/mbilokonsky/ambassador) and serves as the Ambassador bot that is run on the instance. + +This instance is a fork of a fork: this has the [Mastodon Glitch Edition](https://github.com/glitch-soc/mastodon) commits. Documentation for Mastodon Glitch Edition [can be found here](https://glitch-soc.github.io/docs/). Anyone wishing to use Glitch Edition in a Docker image for their own site can use the `pluralcafe/mastodon:glitch` image. + +--- + +## Notable changes from upstream + +See output of `git log glitch..main --oneline | grep -v '[mM]erge' | less` for a (more) complete history. + +* <ol> margin issue fixed so numbered lists aren't cut off a few pixels shy of 1 number +* HTML summary/details tags are allowed in toots +* gemini protocol links are supported (not yet supported: automatically marking gemini:// text as links) +* authentication required for account api endpoints to block some naive scrapers |