|
1 | | -<div align="center"> |
2 | | -<a href="https://joinsharkey.org/"> |
3 | | - <img src="https://activitypub.software/TransFem-org/Sharkey/-/raw/develop/packages/frontend/assets/sharkey.svg" alt="Sharkey logo" style="border-radius:50%" width="300"/> |
4 | | -</a> |
| 1 | +# Nyaakey |
5 | 2 |
|
6 | | -**🌎 **[Sharkey](https://joinsharkey.org/)** is an open source, decentralized social media platform that's free forever! 🚀** |
7 | | - |
8 | | ---- |
9 | | - |
10 | | -<a href="https://fedidb.org/software/sharkey"> |
11 | | - <img src="https://custom-icon-badges.herokuapp.com/badge/find_an-instance-acea31?logoColor=acea31&style=for-the-badge&logo=sharkey&labelColor=363B40" alt="find an instance"/></a> |
12 | | - |
13 | | -<a href="https://docs.joinsharkey.org/docs/install/fresh/"> |
14 | | - <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> |
15 | | - |
16 | | -<a href="./CONTRIBUTING.md"> |
17 | | - <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> |
18 | | - |
19 | | -<a href="https://discord.gg/6VgKmEqHNk"> |
20 | | - <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> |
21 | | - |
22 | | -<a href="https://ko-fi.com/transfem"> |
23 | | - <img src="https://custom-icon-badges.herokuapp.com/badge/donate-F96854?logoColor=F96854&style=for-the-badge&logo=kofi&labelColor=363B40" alt="donate"/></a> |
24 | | - |
25 | | ---- |
26 | | - |
27 | | -</div> |
28 | | - |
29 | | -<div> |
30 | | - |
31 | | -<a href="https://joinsharkey.org/"><img src="https://cdn.shonk.social/files/b671c81c-58cf-4f13-bc96-af0b0c96c667.webp" align="right" height="520px"/></a> |
32 | | - |
33 | | -## ✨ Features |
34 | | -- **ActivityPub support**\ |
35 | | -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! |
36 | | -- **Federated Backgrounds and Music status**\ |
37 | | -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 |
38 | | -- **Mastodon API**\ |
39 | | -Sharkey implements the Mastodon API unlike normal Misskey |
40 | | -- **UI/UX Improvements**\ |
41 | | -Sharkey makes some UI/UX improvements to make it easier to navigate |
42 | | -- **Sign-Up Approval**\ |
43 | | -With Sharkey, you can enable sign-ups, subject to manual moderator approval and mandatory user-provided reasons for joining. |
44 | | -- **Rich Web UI**\ |
45 | | - Sharkey has a rich and easy to use Web UI! |
46 | | - It is highly customizable, from changing the layout and adding widgets to making custom themes. |
47 | | - Furthermore, plugins can be created using AiScript, an original programming language. |
48 | | -- And much more... |
49 | | - |
50 | | -</div> |
51 | | - |
52 | | -<div style="clear: both;"></div> |
53 | | - |
54 | | -## Documentation |
55 | | - |
56 | | -Sharkey Documentation can be found at [Sharkey Documentation](https://docs.joinsharkey.org/docs/install/fresh/) |
| 3 | +Nyaakey is a hyper-optimized fork of [Sharkey](https://activitypub.software/TransFem-org/Sharkey) |
| 4 | +aimed to be as scalable and fast as possible, limited only by I/O and network speed. |
0 commit comments