Add option to modify HTTP pool size
[akkoma] / README.md
index c3ead7fc1a45c717abb0b66ab42b794e9a407000..8d35212aa898c25f76baaf9d6c945f4f4e5bb1c1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,12 +8,33 @@
 
 This is a fork of Pleroma, which is a microblogging server software that can federate (= exchange messages with) other servers that support ActivityPub. What that means is that you can host a server for yourself or your friends and stay in control of your online identity, but still exchange messages with people on larger servers. Akkoma will federate with all servers that implement ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Peertube, and Pixelfed.
 
-Akkoma is written in Elixir and uses PostgresSQL for data storage.
+Akkoma is written in Elixir and uses PostgreSQL for data storage.
 
 For clients it supports the [Mastodon client API](https://docs.joinmastodon.org/api/guidelines/) with Pleroma extensions (see the API section on <https://docs.akkoma.dev/stable/>).
 
 - [Client Applications for Akkoma](https://docs.akkoma.dev/stable/clients/)
 
+## Differences with Pleroma
+
+Akkoma is a faster-paced fork, it has a varied and potentially experimental feature set tailored specifically to the corner of the fediverse inhabited by the project
+creator and contributors.
+
+This should not be considered a one-for-one match with pleroma; it is more opinionated in many ways, and has a smaller community (which is good or
+bad depending on your view)
+
+For example, Akkoma has:
+- Custom Emoji reactions (compatible with misskey)
+- Misskey-flavoured markdown support
+- Elasticsearch and Meilisearch support for search
+- Mastodon frontend (Glitch-Soc and Fedibird flavours) support
+- Automatic post translation via DeepL or LibreTranslate
+- A multitude of heavy modifications to the Pleroma Frontend (Pleroma-FE)
+- The "bubble" concept, in which instance administrators can choose closely-related instances to make a "community of communities", so to say
+
+And takes a more opinionated stance on issues like Domain blocks, which are enforced far more on Akkoma.
+
+Take a look at the Changelog if you want a full list of recent changes, everything since 3.0 has been Akkoma.
+
 ## Installation
 
 ### OTP releases (Recommended)
@@ -25,15 +46,13 @@ If your platform is not supported, or you just want to be able to edit the sourc
 - [Alpine Linux](https://docs.akkoma.dev/stable/installation/alpine_linux_en/)
 - [Arch Linux](https://docs.akkoma.dev/stable/installation/arch_linux_en/)
 - [Debian-based](https://docs.akkoma.dev/stable/installation/debian_based_en/)
-- [Debian-based (jp)](https://docs.akkoma.dev/stable/installation/debian_based_jp/)
 - [FreeBSD](https://docs.akkoma.dev/stable/installation/freebsd_en/)
 - [Gentoo Linux](https://docs.akkoma.dev/stable/installation/gentoo_en/)
 - [NetBSD](https://docs.akkoma.dev/stable/installation/netbsd_en/)
 - [OpenBSD](https://docs.akkoma.dev/stable/installation/openbsd_en/)
-- [OpenBSD (fi)](https://docs.akkoma.dev/stable/installation/openbsd_fi/)
 
 ### Docker
-While we don’t provide docker files, other people have written very good ones. Take a look at <https://github.com/angristan/docker-pleroma> or <https://glitch.sh/sn0w/pleroma-docker>.
+Docker installation is supported via [this setup](https://docs.akkoma.dev/stable/installation/docker_en/)
 
 ### Compilation Troubleshooting
 If you ever encounter compilation issues during the updating of Akkoma, you can try these commands and see if they fix things:
@@ -45,3 +64,4 @@ If you ever encounter compilation issues during the updating of Akkoma, you can
 
 ## Documentation
 - https://docs.akkoma.dev/stable
+- https://docs.akkoma.dev/develop