diff --git a/README.rst b/README.rst index f447ad5..42903b9 100644 --- a/README.rst +++ b/README.rst @@ -96,24 +96,35 @@ ToDo - `Boxcar `_ - `Instapush `_ -Config ------- +Configuring ``ntfy`` +-------------------- -``ntfy`` is configured via a yaml config file stored at -``~/.ntfy.yml``. It requires at minimum 1 keys: backends & a config for any -backend that requires one. +``ntfy`` is configured with a YAML file stored at ``~/.ntfy.yml`` -See the `Configuration docs `_ for more. +Backends +~~~~~~~~ -Example Config: +The backends key specifies what backends to use by default. Each backend has +it's own configuration, stored in a key of it's own name. For example: :: --- - backends - - pushbullet - pushbullet - access_token: T0K3N + backends: + - pushover + - linux + pushover: + user_key: hunter2 + pushbullet: + access_token: hunter2 + +Note: versions prior to v1.0.0 used JSON instead of YAML. + +Note: v0.2.1 and older supported only a single backend, to support old configuration files ntfy will still accept a single backend (a string instead of a list of strings) with the key 'backend'. + +The available backends are in `ntfy.backends `_, +include only the module name in your config (eg: ``pushbullet`` not +``ntfy.backends.pushbullet``). Testing ------- diff --git a/docs/configuring-ntfy.rst b/docs/configuring-ntfy.rst deleted file mode 100644 index b5f47b7..0000000 --- a/docs/configuring-ntfy.rst +++ /dev/null @@ -1,29 +0,0 @@ -Configuring ``ntfy`` -==================== - -``ntfy`` is configured with a YAML file stored at ``~/.ntfy.yml`` - -Backends --------- - -The backends key specifies what backends to use by default. Each backend has -it's own configuration, stored in a key of it's own name. For example: - -:: - - --- - backends: - - pushover - - linux - pushover: - user_key: hunter2 - pushbullet: - access_token: hunter2 - -Note: versions prior to v1.0.0 used JSON instead of YAML. - -Note: v0.2.1 and older supported only a single backend, to support old configuration files ntfy will still accept a single backend (a string instead of a list of strings) with the key 'backend'. - -The available backends are in `ntfy.backends `_, -include only the module name in your config (eg: ``pushbullet`` not -``ntfy.backends.pushbullet``).