readme corrections

yehohanan7 · Feb 12, 2013 · 3a495aa · 3a495aa
1 parent 91b505d
commit 3a495aa
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,9 @@
 (ns avroclj.avrotest
   (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
 (defn person [fields]
   (with-meta fields {:avro-type :avroclj-model-person-Person})
   )