Skip to content
Snippets Groups Projects
README.md 2.56 KiB
Newer Older
syuilo's avatar
syuilo committed
<div align="center">
Amelia Yukii's avatar
Amelia Yukii committed
<a href="https://joinsharkey.org/">
dakkar's avatar
dakkar committed
	<img src="https://activitypub.software/TransFem-org/Sharkey/-/raw/develop/packages/frontend/assets/sharkey.svg" alt="Sharkey logo" style="border-radius:50%" width="300"/>
Kainoa Kanter's avatar
Kainoa Kanter committed
</a>
Amelia Yukii's avatar
Amelia Yukii committed
**🌎 **[Sharkey](https://joinsharkey.org/)** is an open source, decentralized social media platform that's free forever! 🚀**
syuilo's avatar
syuilo committed
---
Marie's avatar
Marie committed
<a href="https://docs.joinsharkey.org/docs/install/fresh/">
Kainoa Kanter's avatar
Kainoa Kanter committed
		<img src="https://custom-icon-badges.herokuapp.com/badge/create_an-instance-FBD53C?logoColor=FBD53C&style=for-the-badge&logo=server&labelColor=363B40" alt="create an instance"/></a>
Mar0xy's avatar
Mar0xy committed
<a href="./CONTRIBUTING.md">
		<img src="https://custom-icon-badges.herokuapp.com/badge/become_a-contributor-A371F7?logoColor=A371F7&style=for-the-badge&logo=git-merge&labelColor=363B40" alt="become a contributor"/></a>

<a href="https://discord.gg/6VgKmEqHNk">
		<img src="https://custom-icon-badges.herokuapp.com/badge/join_the-community-5865F2?logoColor=5865F2&style=for-the-badge&logo=discord&labelColor=363B40" alt="join the community"/></a>

<a href="https://opencollective.com/sharkey">
		<img src="https://custom-icon-badges.herokuapp.com/badge/donate-81ACF4?logoColor=81ACF4&style=for-the-badge&logo=opencollective&labelColor=363B40" alt="donate"/></a>
Mar0xy's avatar
Mar0xy committed

dakkar's avatar
dakkar committed
---
Mar0xy's avatar
Mar0xy committed

syuilo's avatar
syuilo committed
</div>

dakkar's avatar
dakkar committed
<div>
syuilo's avatar
syuilo committed

dakkar's avatar
dakkar committed
<a href="https://joinsharkey.org/"><img src="https://cdn.shonk.social/files/b671c81c-58cf-4f13-bc96-af0b0c96c667.webp" align="right" height="520px"/></a>
dakkar's avatar
dakkar committed

dakkar's avatar
dakkar committed
## ✨ 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**\
Max Walters's avatar
Max Walters committed
You can add a background to your profile as well as a music status via ListenBrainz, show everyone what music you are currently listening to
dakkar's avatar
dakkar committed
- **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...
dakkar's avatar
dakkar committed

dakkar's avatar
dakkar committed
</div>
syuilo's avatar
syuilo committed

dakkar's avatar
dakkar committed
<div style="clear: both;"></div>
dakkar's avatar
dakkar committed
## Documentation
dakkar's avatar
dakkar committed
Sharkey Documentation can be found at [Sharkey Documentation](https://docs.joinsharkey.org/docs/install/fresh/)