Load .env on deb / rpm

[rbdr/lyricli] / README.md

diff --git a/README.md b/README.md
index 6713a7d8d4c33d3d885767ec78cb086f07242fa2..f4d969a991ccbfb27be73527b6e02e299fc3088b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,66 @@
-#Lyricli (lrc)
+# Lyricli (lrc)

 
 

-A command line tool to show the lyrics of your current song
+A command line tool to show the lyrics of your current song.
+
+## Usage
+
+Lyricli can be invoked with the command `lrc`.
+
+```
+$ lrc [-t]
+```
+
+When you run it without arguments, it will look in the available source
+to try to find a playing song and extract the lyrics. If you include the
+`-t` flag, it will show the song and artist names before the lyrics.
+
+```
+$ lrc [-t] <artist_name> <song_name>
+```
+
+When you run it with arguments, it will use them to search for the
+lyrics. This won't work if you manually disable the arguments source in
+your configuration file. If you include the `-t` flag, it will show the
+song and artist names before the lyrics.
+
+### Commands
+
+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 <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
+
+In order to build this project, you'll need a genius client token. See
+the [genius api docs][genius_api_docs] for more information.
+
+The Makefile will read the values from a `.env` file, so you can copy the
+`env.dist` file and fill the values there.
+
+You can build for development just by running make. You can specify the
+profile using the profile environment value `-e profile=release`.
+
+```
+# Build for dev
+make
+
+# Build for release
+make -e profile=release
+```
+
+### Additional Dependencies
+
+On linux you might need to install the libssl-dev and libdbus-dev
+
+[genius_api_docs]: https://docs.genius.com/