Adding README

1 files changed, 27 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..760fd12
--- /dev/null
+++ b/README
@@ -0,0 +1,27 @@
+# Warlock!
+
+1) Create a class
+
+    import warlock
+
+	schema = {
+	    'name': 'Country':
+	    'properties': {
+	        'name': {'type': 'string'},
+	        'abbreviation': {'type': 'string'},
+	    },
+	}
+
+	Country = warlock.schema_class(schema)
+
+2) Create an object using your class
+
+	sweden = Country(name='Sweden', abbreviation='SE')
+
+3) Let the object validate itself!
+
+    sweden.name = 5
+    # Raises ValueError
+
+    sweden.overlord = 'Brian'
+    # Raises AttributeError