X-Git-Url: https://git.r.bdr.sh/rbdr/lyricli/blobdiff_plain/ee966aa755acd8eea53c982e43e13aef4f193984..3a398bc031f1a1659073208e83d778a357a8243a:/README.md diff --git a/README.md b/README.md index 5e7c995..b2c5430 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,26 +25,38 @@ 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-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-source ` 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 3.1. Building defaults +The build has only been tested on OSX using Swift 5.8 Building defaults to the debug configuration. ``` make ``` +### Configuration + +To avoid storing the API key in source control, clientToken in the +lyrics_engine is using a placeholder value. You'll need to replace this +before building + +* `GENIUS_CLIENT_TOKEN`: The Client token for your genius API client + ## Installing from source Builds lyricli in release configuration and copies the executable as @@ -78,8 +89,6 @@ tests. make test ``` -[![Build Status](https://travis-ci.org/lyricli-app/lyricli.svg?branch=master)](https://travis-ci.org/lyricli-app/lyricli) - [swiftlint]: https://github.com/realm/SwiftLint [jazzy]: https://github.com/realm/jazzy [sourcekitten]: https://github.com/jpsim/SourceKitten