Add placeholder README

4 years ago · 50aca3940e
parent e74b675b3a
commit 50aca3940e
1 changed files with 5 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,5 @@
+# @validatem/validation-result
+
+Documentation for this module has not been written yet. By the time it reaches 1.0.0, it will have full documentation.
+
+In the meantime, check out the `example.js` file in the repository for a usage demonstration.