readme corrections

yehohanan7 · Feb 13, 2013 · 5a02193 · 5a02193
1 parent 3a495aa
commit 5a02193
Showing 1 changed file with 22 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -7,8 +7,12 @@
   (require '[avroclj.avro :as avro]))
 
 
-;The avro schema to use for serializing/desrializing should be attached to the clojure map using the meta key :avro-type
-;in the below example, avroclj will look for "avroclj/model/person/Person.avsc" in the class path
+;The avro schema to use for serializing/desrializing should be attached to the
+;clojure map using the meta key :avro-type
+
+;in the below example, avroclj will look for the avro schema file : "avroclj/model/person/Person.avsc" in the class path
+;to serialize/deserialize
+
 (defn person [fields]
   (with-meta fields {:avro-type :avroclj-model-person-Person})
   )
@@ -23,6 +27,22 @@
 ```
 
 
+##avroclj/model/person/Person.avsc
+
+```json
+{
+  "namespace": "avroclj.model.person",
+  "type" : "record",
+  "name" : "Person",
+  "doc" : "Represents a Person",
+  "fields" : [
+    {"name" : "firstName", "type" : "string"},
+    {"name" : "middleName", "type" : "string"},
+    {"name" : "lastName", "type" : "string"}
+  ]
+}
+```
+
 ## Installation