From 521f36f6c0a3ba983e2230d4c28f71f910528531 Mon Sep 17 00:00:00 2001 From: finga Date: Thu, 16 Feb 2023 16:10:26 +0100 Subject: [PATCH] readme: Further improve the readme [CI SKIP] Improve wording and readability. --- README.md | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 20505dd..1cf384e 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,18 @@ send a reminder email containing a certain title and message. ## Setup There are two basic steps to install remindrs. First it is recomended -to prepare the Database and then build the binary or build and install +to prepare the Database. Then build the binary or build and install the Debian package. ### Database -Prepare an empty Postgres database preferably with an extra user. +Prepare an empty Postgres database preferably together with an +separate user. ### Building -Remindrs can be built in two ways. By using the classic Rust -toolchain to build a binary. And by using +Remindrs can be built in two ways. By using the classic Rust toolchain +to build a binary. Or by using [`cargo-deb`](https://github.com/kornelski/cargo-deb) to build a Debian package. @@ -41,20 +42,23 @@ cargo deb ``` The generated Debian package also installs a systemd service unit, but -does not enable it by default. +does not enable it by default in order to prepare the configuration +first. #### Configuraion -To configure remindrs the following configuration options are -available. When remindrs is started it tries to load the configuration -either from the path passed as the command line argument -`-c`/`--config`, or by the default paths. Those are `./config.toml`, +When remindrs is started it tries to load the configuration either +from the path passed as the command line argument `-c`/`--config`, or +by the default paths. Those are `./config.toml`, `$XDG_CONFIG_HOME/remindrs/config.toml` or `$HOME/.config/remindrs/config.toml` if `$XDG_CONFIG_HOME` is not set, and finally `/etc/remindrs/config.toml`. -Note that all options commented out have the given parameter as a -default value and are not mandatory. +To configure remindrs the following configuration options are +available. + +> Note that all options that are commented out have the given +> parameter as a default value and are not mandatory. ``` [database] @@ -96,7 +100,7 @@ Options: In order to create a reminder send a `POST` request to the API endpoint. -For example `curl` can be used like the following: +This may be done for example with `curl` like the following: ```sh curl -X POST localhost:8080/v1/reminder \