finga/remindrs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

readme: Further improve the readme [CI SKIP]

Browse source 
Improve wording and readability.
This commit is contained in:
finga 2023-02-16 16:10:26 +01:00
parent 5627d96f2a
commit 521f36f6c0
1 changed files with 16 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -6,17 +6,18 @@ send a reminder email containing a certain title and message.
## Setup ## Setup
There are two basic steps to install remindrs. First it is recomended 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. the Debian package.
### Database ### Database
Prepare an empty Postgres database preferably with an extra user. Prepare an empty Postgres database preferably together with an
separate user.
### Building ### Building
Remindrs can be built in two ways. By using the classic Rust Remindrs can be built in two ways. By using the classic Rust toolchain
toolchain to build a binary. And by using to build a binary. Or by using
[`cargo-deb`](https://github.com/kornelski/cargo-deb) to build a [`cargo-deb`](https://github.com/kornelski/cargo-deb) to build a
Debian package. Debian package.
@ -41,20 +42,23 @@ cargo deb
``` ```
The generated Debian package also installs a systemd service unit, but 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 #### Configuraion
To configure remindrs the following configuration options are When remindrs is started it tries to load the configuration either
available. When remindrs is started it tries to load the configuration from the path passed as the command line argument `-c`/`--config`, or
either from the path passed as the command line argument by the default paths. Those are `./config.toml`,
`-c`/`--config`, or by the default paths. Those are `./config.toml`,
`$XDG_CONFIG_HOME/remindrs/config.toml` or `$XDG_CONFIG_HOME/remindrs/config.toml` or
`$HOME/.config/remindrs/config.toml` if `$XDG_CONFIG_HOME` is not set, `$HOME/.config/remindrs/config.toml` if `$XDG_CONFIG_HOME` is not set,
and finally `/etc/remindrs/config.toml`. and finally `/etc/remindrs/config.toml`.
Note that all options commented out have the given parameter as a To configure remindrs the following configuration options are
default value and are not mandatory. available.
> Note that all options that are commented out have the given
> parameter as a default value and are not mandatory.
``` ```
[database] [database]
@ -96,7 +100,7 @@ Options:
In order to create a reminder send a `POST` request to the API In order to create a reminder send a `POST` request to the API
endpoint. endpoint.
For example `curl` can be used like the following: This may be done for example with `curl` like the following:
```sh ```sh
curl -X POST localhost:8080/v1/reminder \ curl -X POST localhost:8080/v1/reminder \