From 007a9371e7f6aade55130675fc82e3179a31619e Mon Sep 17 00:00:00 2001
From: Sebastian Kippe <sebastian@kip.pe>
Date: Mon, 5 Jun 2017 16:28:42 +0200
Subject: [PATCH] Add README

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e61c285
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+This repository/module contains JSON Schema definitions as well as examples for
+Kosmos data formats.
+
+## Usage
+
+You can import these schemas to validate data in JavaScript programs. For
+example using npm and the [tv4](https://www.npmjs.com/package/tv4) JSON Schema
+validator:
+
+```js
+let tv4 = require('tv4');
+let schemas = require('kosmos-schemas');
+
+let result = tv4.validate(contributor, schemas['contributor']);
+
+if (result) {
+  console.log('Your data is valid');
+} else {
+  console.log('Your data is not valid:');
+  console.log(tv4.error);
+}
+```
+
+## TODO
+
+* Add script for publishing both human- and machine-readable schemas to
+  https://schemas.kosmos.org