diff --git a/README.md b/README.md index 7498a357..4be6320b 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,34 @@
Iceshrimp is a decentralized and federated social networking service, implementing the ActivityPub standard.
-This repository contains our efforts to continue the Iceshrimp project's legacy - in the form of an entirely new codebase, with a focus on performance, stability and maintainability.
Iceshrimp is a decentralized and federated social networking service, implementing the ActivityPub standard.
-Want to set up an instance? Have a look at the [documentation](https://kb.iceshrimp.dev/s/docs) & the [feature comparison matrix](https://kb.iceshrimp.dev/s/docs/doc/production-readiness-Bs0HK2ZXO8)! - -Want to join development efforts? Have a look at the [knowledgebase](https://kb.iceshrimp.dev) and join the [chat room](https://chat.iceshrimp.dev)! - -Want to donate to the project? +- Highlighted features: + - All-new, blazingly fast & resource-efficient backend (written in .NET) + - All-new frontend (written in Blazor) + - Well-supported migration path from Iceshrimp-JS + - So much more - Read the [changelog](CHANGELOG.md) and join the [chat room](https://chat.iceshrimp.dev) to follow the development! +- Don't like the Web UI? We test our Mastodon-compatible API against the following clients: + - [Elk](https://elk.zone), [Phanpy](https://phanpy.social/), [Enafore](https://enafore.social/), [Masto-FE-standalone](https://iceshrimp.dev/iceshrimp/masto-fe-standalone) (Web) + - [Mona](https://apps.apple.com/us/app/mona-for-mastodon/id1659154653), [Toot!](https://apps.apple.com/us/app/toot-for-mastodon/id1229021451), [Ice Cubes](https://apps.apple.com/us/app/ice-cubes-for-mastodon/id6444915884), [Tusker](https://apps.apple.com/us/app/tusker/id1498334597), [Feditext](https://github.com/feditext/feditext), [Mastodon](https://apps.apple.com/us/app/mastodon-for-iphone-and-ipad/id1571998974) (iOS) + - [Tusky](https://tusky.app/), [Subway Tooter](https://github.com/tateisu/SubwayTooter), [Moshidon](https://lucasggamerm.github.io/moshidon/), [Megalodon](https://sk22.github.io/megalodon/), [Mastodon](https://play.google.com/store/apps/details?id=org.joinmastodon.android) (Android) +- Project goals: + - Provide a community-centric alternative to the big ActivityPub SNS projects + - Strong focus on maintainability, stability & performance, as well as user choice and configurability + - Prioritization bug fixes over features +- Project anti-goals: + - Flashy marketing + - Commercialization of any kind +- Want to set up an instance? + - Have a look at the [documentation](https://kb.iceshrimp.dev/s/docs) & the [feature comparison matrix](https://kb.iceshrimp.dev/s/docs/doc/production-readiness-Bs0HK2ZXO8)! + - Please note that we do not operate a "flagship instance", the only project-affiliated domains are `iceshrimp.dev` and `iceshrimp.net`. +- Want to join development efforts? + - Have a look at the [knowledgebase](https://kb.iceshrimp.dev) and join the [chat room](https://chat.iceshrimp.dev)! +- Want to donate to the project? - Our frontend dev (Lilian) needs help paying for healthcare costs. You can contribute [here](https://bunq.me/lilianhealthcarefund). Money from the fund will be used for co-pays, and medical expenses not covered by insurance. --- > **Note** -> This is beta software. While the Mastodon client API is relatively complete, the frontend is not. It is therefore not advisable to upgrade existing Iceshrimp instances at present. Setting up staging instances to help us with testing is very appreciated, however, and will help us ensure eventual upgrades go as smoothly as possible. +> This is beta software. The Mastodon client API is relatively complete, the frontend is rapidly improving. Nonetheless, we don't recommend to upgrade existing Iceshrimp-JS instances quite yet. Setting up new instances and reporting bugs is very appreciated, however, and will help us ensure eventual upgrades go as smoothly as possible. > > If everything goes well, we estimate that there'll be a stable release by the end of 2024.