From 83fa2764836625b1bbea40ef47892f480e923807 Mon Sep 17 00:00:00 2001 From: dakkar Date: Sat, 2 Mar 2024 16:49:02 +0000 Subject: [PATCH] put back the readme --- README.md | 35 +++++++++++++++++++++++------------ 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 42b7fb18ae..c002acbff9 100644 --- a/README.md +++ b/README.md @@ -22,24 +22,35 @@ donate - +--- -## Thanks +
-Chromatic + -Thanks to [Chromatic](https://www.chromatic.com/) for providing the visual testing platform that helps us review UI changes and catch visual regressions. +## ✨ 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... -Codecov +
-Thanks to [Codecov](https://about.codecov.io/for/open-source/) for providing the code coverage platform that helps us improve our test coverage. +
-Crowdin +## Documentation -Thanks to [Crowdin](https://crowdin.com/) for providing the localization platform that helps us translate Misskey into many languages. - -Docker - -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/)