From ac5547a24591f3cc04e6caf0ef31700c19b06cef Mon Sep 17 00:00:00 2001 From: Robert Bost Date: Mon, 23 Nov 2020 21:25:57 -0700 Subject: [PATCH] Update README.md --- README.md | 43 +++++++++++++++++++++++++++++-------------- 1 file changed, 29 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 2c1ad9b..daa33de 100644 --- a/README.md +++ b/README.md @@ -14,15 +14,26 @@ A keyboard macro tool. * [Managing phrase entries](#managing-phrase-entries) -# Installation +# Installation and Upgrade + + +The following packages will install two commands: + +- `qk` +- `quikey-daemon` + +Everything can be managed using just `qk` and examples are [further below](#usage). + ## Python 3 ```shell -$ pip3 install --user quikey +$ pip3 install --user quikey +$ pip3 install --user -U quikey #<-- Upgrade ``` or ```shell $ python3 -m pip install --user quikey +$ python3 -m pip install --user -U quikey #<-- Upgrade ``` ## Arch Linux (AUR) @@ -34,6 +45,7 @@ $ curl -L -O https://aur.archlinux.org/cgit/aur.git/snapshot/quikey.tar.gz && ta ```shell $ dnf copr enable bostrt/quikey # Enable repo $ dnf install quikey # Install pkg +$ dnf update quikey # Update pkg ``` ## Ubuntu, Debian, MXLinux, Mint, etc (PPA) @@ -41,26 +53,21 @@ $ dnf install quikey # Install pkg coming soon ``` -The packages above install two executables: -- `qk` -- `quikey-daemon` - -Everything can be managed using just `qk` and examples are below. - # Usage -## Quickstart - - - ## Managing the daemon There is a daemon process that must be running for Quikey's macro functionality to run. You can manage the daemon from the `qk` client: -#### Start daemon +### Start daemon ```shell $ qk start ``` +### Autostart on Login +```shell +$ qk autostart enable +``` + ### Stop daemon ```shell $ qk stop @@ -84,6 +91,14 @@ $ qk ls +---------+------+----------------------------+-----------------------------+ ``` + +### Interactive editing +Use interactive menus to edit and remove phrases: +``` +$ qk edit +$ qk rm +``` + ### Editing a phrase ```shell $ qk edit -n ':hello:' @@ -98,4 +113,4 @@ quikey phrase with key of :hello: has been deleted. ## Development -See [DEVELOP.md](DEVELOP.md) for help. \ No newline at end of file +See [DEVELOP.md](DEVELOP.md) for help.