Merge branch 'release/1.0.0'

[rbdr/lyricli] / README.md

diff --git a/README.md b/README.md
index 2e7545c64e0de032fe36db6287cd1f1b5c9bcfc0..57dff9a286981385065aea2ad5f9a0529002e395 100644 (file)
--- a/README.md
+++ b/README.md
@@ -28,18 +28,18 @@ song and artist names before the lyrics.
 
 In order to configure
 
 
 In order to configure
 

-* `lrc -l` or `lrc --list-sources` lists the available sources. Enabled
+* `lrc -l` or `lrc --list` 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
   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
+* `lrc -r` or `lrc --reset <source>` resets the configuration for

   a source and disables it.
 * `lrc -v` or `lrc --version` prints the version
 * `lrc -h` or `lrc --help` display built-in help
 
 ## Building
 
   a source and disables it.
 * `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.0.1. Building defaults

 to the debug configuration.
 
 ```
 to the debug configuration.
 
 ```


@@ -63,6 +63,12 @@ This can be done by overriding the `install_path` variable
 make install install_path=/opt/bin
 ```
 
 make install install_path=/opt/bin
 ```
 

+## Linting and Generating Documentation
+
+We use [swiftlint][swiftlint] to lint, and `make lint` to run it.
+We use [jazzy][jazzy] and [SourceKitten][sourcekitten] to document, and
+`make document` to generate it.
+

 ## Running tests
 
 No tests at the moment 😬... but the makefile is mapped to run the swift
 ## Running tests
 
 No tests at the moment 😬... but the makefile is mapped to run the swift


@@ -71,3 +77,7 @@ tests.
 ```
 make test
 ```
 ```
 make test
 ```

+
+[swiftlint]: https://github.com/realm/SwiftLint
+[jazzy]: https://github.com/realm/jazzy
+[sourcekitten]: https://github.com/jpsim/SourceKitten