add readme

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..a878a8e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# configvalidator
+
+A Java library that you can include in your IDE or tooling plugins to validate your
+configuration variables.
+
+A first party CLI tool that uses this library is also provided as a native executable with
+GraalVM.
+
+## Usage
+
+TODO
+
+## Architecture
+
+TODO
+
+## License
+
+MIT
\ No newline at end of file