Use a dummy token for the client

[rbdr/lyricli] / README.md

diff --git a/README.md b/README.md
index 5e7c9951e48d0f52e7cb60bf13ed5e0140735366..b2c5430aad68472af3d8622867ed7376e10ff52e 100644 (file)
--- 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 <source>` enables a source
-* `lrc -d` or `lrc --disable <source>` disables a source
-* `lrc -r` or `lrc --reset-source <source>` resets the configuration for
-  a source and disables it.
+* `lrc -e` or `lrc --enable-source <source>` enables a source
+* `lrc -d` or `lrc --disable-source <source>` disables a source without
+  resetting its configuration.
+* `lrc -r` or `lrc --reset-source <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