Merge pull request #22 from jmatsu/tweakReadme

Prepare for 0.3

CHANGELOG.md

@@ -1,3 +1,9 @@
+## Version 0.3 (2020/04/07)
+
+- Fixed missing `</body>` in the html template
+- Fixed unintended *wider* html page had been generated
+- Raise the error in advance when the file of license-tools-plugin is not found
+
 ## Version 0.2 (2020/04/07)
 
 - Fixed assembly/visualization options caused missing property errors in Groovy code

README.md

@@ -257,7 +257,7 @@ plugins {
 }
 
 licenseTools {
-  licensesYaml = ... // this propery is supported
+  licensesYaml = ... // this property is supported
   ignoreGroups = [...] // this property is also supported
 }
 
@@ -334,7 +334,33 @@ Please check the original `ftl` file for variables that you can use.
 
 ### Render Json
 
-The schema of json objects are defined in `schema` module published to jcetner. You can chose any serialization method, custom attribute transformation, and so on.
+You can generate resources in json format.
+
+```kotlin
+licenseList {
+  variants {
+    freeRelease {
+            visualization {
+                format = "json"
+            }
+        }
+    }
+}
+```
+
+The schema of the json resources are defined in `schema` module, which is published to jcenter.
+
+```kotlin
+repositories {
+  jcenter()
+}
+
+dependencies {
+  implementation("io.github.jmatsu:license-list-schema:<version>")
+}
+```
+
+They are just *interfaces* in pure Kotlin (== Java fully-compatible classes). So you can chose any serialization method, custom attribute transformation, and so on in the both of Java and Kotlin.
 
 ## Limitations
 

VERSION

@@ -1 +1 @@
-0.2
+0.3