Merge pull request #27 from benjishults/minor-tweaks

add stuff to README

Author: benjishults

README.md

@@ -1,3 +1,47 @@
 # console
 
-library for building console-menu applications
+A library for building console-menu applications.
+
+## Library
+
+Available at
+
+```xml
+
+<dependency>
+    <groupId>io.github.benjishults</groupId>
+    <artifactId>console</artifactId>
+    <version>3.1.0</version>
+</dependency>
+```
+
+[API Documentation](https://benjishults.github.io/console/dokka/html/lib/index.html)
+
+## Test Helpers
+
+The test library does use KoTest assertions and provides extension functions on the KoTest Spec class.
+
+Available at
+
+```xml
+
+<dependency>
+    <groupId>io.github.benjishults</groupId>
+    <artifactId>console-test</artifactId>
+    <version>3.1.0</version>
+</dependency>
+```
+
+[API Documentation](https://benjishults.github.io/console/dokka/html/test/index.html)
+
+## Example Usage
+
+An example usage can be found in the [budget](https://github.com/benjishults/budget) repository.
+
+## Fun Stuff
+
+Here's how I [publish the maven artifacts](./.github/workflows/publish.yml).
+
+Here's how I [generate and publish the dokka pages](./.github/workflows/dokka.yml).
+
+Here's how I [run tests when a pull request is created](./.github/workflows/test.yml).