From 877367fa167b7d40480734ca9aceedef48a838f8 Mon Sep 17 00:00:00 2001 From: James Moy Date: Fri, 8 Dec 2023 20:39:40 -0500 Subject: [PATCH] Update README.md Update readme --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5dde58ccc1..2fa34aa218 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,20 @@ -
- - Sharkey logo - - **🌎 **[Sharkey](https://joinsharkey.org/)** is an open source, decentralized social media platform that's free forever! 🚀** ---- +**Note:** This repo contains some changes specifically made for [Sakurajima Social](https://sakurajima.social) and will contain references to it. This repo is here to comply with the AGPL and also deploy changes to our instance. Use at your own risk, using the official repo is recommended. + +# Differences from the Upstream Version (all on the Frontend) +* "Have a look at the timeline" is a button instead a timeline widget when logged out so the user can view the local and global timelines comfortably. +* Change interface font to match Sakurajima Mastodon server +* Sakura themes are the default themes along with Yozakura for dark mode. They are built into thias version +* Added menu items pertaining to Sakurajima in the instance menu +* Added Rose Pine themes from Firefish +* Removed the Advertisement menu item (Sakurajima Social has no ads and never will) +* Different defaults to make Sharkey more approachable for users who used Twitter/X. +* Added link to the repo of the Sakura version of Sharkey. +* Only show public posts from non-silenced hosts for tag search. +--- +
find an instance @@ -49,7 +57,3 @@ With Sharkey, you can enable sign-ups, subject to manual moderator approval and
- -## Documentation - -Sharkey Documentation can be found at [Sharkey Documentation](https://docs.joinsharkey.org/docs/install/fresh/)