From c53df649c817f770ae1750bb6d11113e0bcd2b18 Mon Sep 17 00:00:00 2001 From: Ruben Beltran del Rio Date: Mon, 10 Apr 2023 13:02:51 +0200 Subject: Update code, add source management config --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 57dff9a..6d6046a 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,7 @@ A command line tool to show the lyrics of your current song. ## Usage -Lyricli can be invoked with the command `lrc`. It can be invoked without -arguments, with an artist and song or with a special command: +Lyricli can be invoked with the command `lrc`. ``` $ lrc [-t] @@ -26,20 +25,24 @@ song and artist names before the lyrics. ### Commands -In order to configure +In order to configure sources, lyricli provides a few commands: -* `lrc -l` or `lrc --list` lists the available sources. Enabled +* `lrc -l` or `lrc --list-sources` lists the available sources. Enabled sourcess will have a `*` -* `lrc -e` or `lrc --enable ` enables a source -* `lrc -d` or `lrc --disable ` disables a source -* `lrc -r` or `lrc --reset ` resets the configuration for - a source and disables it. +* `lrc -e` or `lrc --enable-source ` enables a source +* `lrc -d` or `lrc --disable-source ` disables a source without + resetting its configuration. +* `lrc -r` or `lrc --reset-source ` resets the configuration + for a source and disables it. + +And you can print the help or the version: + * `lrc -v` or `lrc --version` prints the version * `lrc -h` or `lrc --help` display built-in help ## Building -The build has only been tested on OSX using Swift 5.0.1. Building defaults +The build has only been tested on OSX using Swift 5.8 Building defaults to the debug configuration. ``` -- cgit v1.2.3-70-g09d2