diff --git a/README.md b/README.md index 42b7fb18ae23213d3c19f9e8ab2f1cf392adebb5..c002acbff9da7b32b532dadb5d17953d7ac4b96f 100644 --- a/README.md +++ b/README.md @@ -22,24 +22,35 @@ <a href="https://ko-fi.com/transfem"> <img src="https://custom-icon-badges.herokuapp.com/badge/donate-F96854?logoColor=F96854&style=for-the-badge&logo=kofi&labelColor=363B40" alt="donate"/></a> -<a href="https://joinsharkey.org/"><img src="https://cdn.shonk.social/files/b671c81c-58cf-4f13-bc96-af0b0c96c667.webp" align="right" height="520px"/></a> +--- </div> -## Thanks - -<a href="https://www.chromatic.com/"><img src="https://user-images.githubusercontent.com/321738/84662277-e3db4f80-af1b-11ea-88f5-91d67a5e59f6.png" height="30" alt="Chromatic" /></a> +<div> -Thanks to [Chromatic](https://www.chromatic.com/) for providing the visual testing platform that helps us review UI changes and catch visual regressions. - -<a href="https://about.codecov.io/for/open-source/"><img src="https://about.codecov.io/wp-content/themes/codecov/assets/brand/sentry-cobranding/logos/codecov-by-sentry-logo.svg" height="30" alt="Codecov" /></a> +<a href="https://joinsharkey.org/"><img src="https://cdn.shonk.social/files/b671c81c-58cf-4f13-bc96-af0b0c96c667.webp" align="right" height="520px"/></a> -Thanks to [Codecov](https://about.codecov.io/for/open-source/) for providing the code coverage platform that helps us improve our test coverage. +## ✨ Features +- **ActivityPub support**\ +Not on Sharkey? No problem! Not only can Sharkey instances talk to each other, but you can make friends with people on other networks like Mastodon and Pixelfed! +- **Federated Backgrounds and Music status**\ +You can add a background to your profile as well as a music status via ListenBrainz, show everyone what music you are currently listening too +- **Mastodon API**\ +Sharkey implements the Mastodon API unlike normal Misskey +- **UI/UX Improvements**\ +Sharkey makes some UI/UX improvements to make it easier to navigate +- **Sign-Up Approval**\ +With Sharkey, you can enable sign-ups, subject to manual moderator approval and mandatory user-provided reasons for joining. +- **Rich Web UI**\ + Sharkey has a rich and easy to use Web UI! + It is highly customizable, from changing the layout and adding widgets to making custom themes. + Furthermore, plugins can be created using AiScript, an original programming language. +- And much more... -<a href="https://crowdin.com/"><img src="https://user-images.githubusercontent.com/20679825/230709597-1299a011-171a-4294-a91e-355a9b37c672.svg" height="30" alt="Crowdin" /></a> +</div> -Thanks to [Crowdin](https://crowdin.com/) for providing the localization platform that helps us translate Misskey into many languages. +<div style="clear: both;"></div> -<a href="https://hub.docker.com/"><img src="https://user-images.githubusercontent.com/20679825/230148221-f8e73a32-a49b-47c3-9029-9a15c3824f92.png" height="30" alt="Docker" /></a> +## Documentation -Thanks to [Docker](https://hub.docker.com/) for providing the container platform that helps us run Misskey in production. +Sharkey Documentation can be found at [Sharkey Documentation](https://docs.joinsharkey.org/docs/install/fresh/)