semaphore/README.md

34 lines
1.6 KiB
Markdown

<img height="100" width="100" src="https://user-images.githubusercontent.com/2445413/213867232-8bd90121-8812-446e-8c2f-d4000388d449.png" alt=""/>
# Semaphore
An alternative web client for [Mastodon](https://joinmastodon.org), focused on accessibility.
Semaphore is available at [semaphore.social](https://semaphore.social). Beta releases are at [beta.semaphore.social](https://beta.semaphore.social).
For updates and support, follow [@semaphore@fosstodon.org](https://fosstodon.org/@semaphore).
See the [user guide](https://github.com/semaphore-social/semaphore/blob/main/docs/User-Guide.md) for basic usage. See the [admin guide](https://github.com/semaphore-social/semaphore/blob/main/docs/Admin-Guide.md) if Semaphore cannot connect to your instance.
## With thanks to
This is a continuation of the [Pinafore project](https://github.com/nolanlawson/pinafore).
Credit goes go to [Nolan Lawson](https://nolanlawson.com/) and the original contributors for their excellent work.
## Changelog
For a changelog, see the [GitHub releases](http://github.com/semaphore-social/semaphore/releases/).
For a list of breaking changes, see [BREAKING_CHANGES.md](https://github.com/semaphore-social/semaphore/blob/main/BREAKING_CHANGES.md).
## Developing and testing
See [CONTRIBUTING.md](https://github.com/semaphore-social/semaphore/blob/main/CONTRIBUTING.md) for
how to run Semaphore in dev mode and run tests.
## What's with the name?
Semaphore is a fork of Pinafore and apparently they were going to call the boat H.M.S Semaphore but thought Pinafore was more fun.
Bonus - semaphore is an old communication method.