Doc & Readme updates

README.md

@@ -3,9 +3,45 @@
 # dichotomy
 Either and Result monadic types for Java
 
-## TODO: 
+## TODO:
     * finish docs (particularly package docs, usage examples)
     * nice intro (with synopsis and short examples)
-    * CI / actions   *in progress* (working on code signing...)
+
+
+Download
+--------
+depend via Maven:
+
+```xml
+<dependency>
+  <groupId>net.xyzsd</groupId>
+  <artifactId>dichotomy</artifactId>
+  <version>0.9</version>
+  <type>module</type>
+</dependency>
+```
+
+or Gradle:
+```kotlin
+implementation("net.xyzsd:dichotomy:0.9")
+```
+
+
+
+License
+-------
+Copyright 2022, xyzsd
+
+Licensed under either of:
+
+* Apache License, Version 2.0
+  (see LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
+* MIT license
+  (see LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+
+
 
 

src/main/java/net/xyzsd/dichotomy/result/Result.java

@@ -21,7 +21,7 @@
  * each of which can have its own non-null type
  * <ul>
  *     <li>OK: Success</li>
- *     <li>Err: Failure</li>
+ *     <li>Err: Failure (not required to be an {@link Exception})</li>
  * </ul>
  * If there is no associated type, use the {@link None} type rather than {@link Void}.
  * <p>