diff --git a/README.md b/README.md index 1fe028939..95964691c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ -# BNAkkoma – Brand New Akkoma +# BNAkkoma: Brand New Akkoma - -*It's not that new. It's just a pun on a so-called anime.* - +It's not that new. This is just a cheap pun on the title of a [furry anime](https://en.wikipedia.org/wiki/BNA:_Brand_New_Animal). ## What is this? @@ -15,8 +13,11 @@ The main differences between this and the upstream repository are - Files/directories to mount are minified and completely separated from the repository files, allowing better control over file permissions - Has an actual Docker entry point, rather than a command that pretends to be an entry point - Includes out-of-the-box support for [PGroonga](https://pgroonga.github.io/), the fast and accurate full-text search extension for PostgreSQL -- Added support for searching media status, which I really needed +- Added support for searching media posts, which I really needed +- Added support to search for posts from people you follow, which is nice to have +- These search extensions are configurable, so simply turn off if you don't want them - Includes some improvements to the initial configuration wizard +- Improved PWA support, sort of - Supports Podman quite well ## How to setup (Podman Rootless) @@ -202,6 +203,7 @@ Keep in mind that all of these steps are optional. Before proceeding, make sure that `config :pleroma, :database, pgroonga_enabled` is set to `false`. ```ex +# Example configuration config :pleroma, :database, rum_enabled: false, pgroonga_enabled: false @@ -219,9 +221,10 @@ podman exec -it akkoma-web \ After running the migration, change `config :pleroma, :database, pgroonga_enabled` to `true`. ```ex +# Example configuration config :pleroma, :database, rum_enabled: false, - pgroonga_enabled: true # set this option to true + pgroonga_enabled: true ``` Don't forget to restart your backend for the changes to take effect.