From 872a76ae221631a573f1d414e32d7623b52debfd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ravi=20S=2E=20R=C4=81mphal?= Date: Sun, 2 Sep 2018 22:36:36 -0700 Subject: [PATCH 1/3] adjust README header --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3c01bc5..94be3e8 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Open a notification in the top-right corner of your screen and display a "Reply" ## Actions alert Open a notification in the top-right corner of your screen and display one or more actions to click on. -# Features +## Features * set alert's icon, title, subtitle, image. * capture text typed by user in the reply type alert. * timeout : automatically close the alert notification after a delay. From 25acb11b74c0d579d39911506c51b67dcb5041f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ravi=20S=2E=20R=C4=81mphal?= Date: Sun, 2 Sep 2018 22:37:16 -0700 Subject: [PATCH 2/3] added installation instructions to the README and combined them with the previously available Download section --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 94be3e8..5bba342 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,14 @@ Open a notification in the top-right corner of your screen and display one or mo * value or json output on alert's event (closed, timeout, replied, activated...) * close the alert notification on SIGINT, SIGTERM. -## Download +## Installation -Prebuilt binaries are available from the +1. Download the zipped precompiled binary from the [releases section](https://github.com/vjeantet/alerter/releases). +2. Extract the binary. +3. Use as described below. + +**NOTE**: If you don't want to have to specify the absolute/relative path to the binary, you can place the binary in any folder that is in your `$PATH` so that your system can automatically find it. If you would like to see which directories are currently in your `$PATH`, you can run `echo $PATH`. ## Usage From 91c9a2c729215159f9e194aad6603017d38f446f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ravi=20S=2E=20R=C4=81mphal?= Date: Sun, 2 Sep 2018 22:42:23 -0700 Subject: [PATCH 3/3] added copy instructions to README --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5bba342..c57bab7 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,17 @@ Open a notification in the top-right corner of your screen and display one or mo 2. Extract the binary. 3. Use as described below. -**NOTE**: If you don't want to have to specify the absolute/relative path to the binary, you can place the binary in any folder that is in your `$PATH` so that your system can automatically find it. If you would like to see which directories are currently in your `$PATH`, you can run `echo $PATH`. +### Adding to `$PATH` + +If you don't want to have to specify the absolute/relative path to the binary, you can place the binary in any directory that is listed in your `$PATH` so that your system can automatically find it. + +If you would like to see which directories are currently in your `$PATH`, you can run `echo $PATH`. + +You can use the `cp` command to copy the binary to your chosen directory. For example: + +```shell +cp ~/Downloads/alerter /path/to/directory/you/choose/ +``` ## Usage