diff --git a/README.adoc b/README.adoc index 523c8d7..6feb7c4 100644 --- a/README.adoc +++ b/README.adoc @@ -59,7 +59,7 @@ the non-optional tests, and all but two of the optional tests. [source,clojure] ---- -(require '[juxt.jinx-alpha-2 :as jinx]) +(require '[juxt.jinx.alpha :as jinx]) ---- === Create a schema @@ -88,11 +88,11 @@ the non-optional tests, and all but two of the optional tests. == Schemas A schema is a Clojure map (or boolean) that should be augmented with -metadata by calling `juxt.jinx.schema/schema` on the schema data: +metadata by calling `juxt.jinx.alpha/schema` on the schema data: [source,clojure] ---- -(juxt.jinx.schema/schema {"type" "object"}) +(jinx/schema {"type" "object"}) ---- == Resolvers @@ -101,11 +101,11 @@ Validation can take an optional options map. The `:resolvers` entry should be a collection of resolvers. -* `:juxt.jinx.resolve/built-in` is the built-in resolver which will resolve schemas contained in the library, such as the draft7 meta-schema. +* `:juxt.jinx.alpha.resolve/built-in` is the built-in resolver which will resolve schemas contained in the library, such as the draft7 meta-schema. -* `:juxt.jinx.resolve/default-resolver` is a resolver which takes an argument of a map of URIs (or regexes) to values. +* `:juxt.jinx.alpha.resolve/default-resolver` is a resolver which takes an argument of a map of URIs (or regexes) to values. + -A value can be a schema (which should be pre-processed with schema metadata by calling `juxt.jinx.schema/schema`). +A value can be a schema (which should be pre-processed with schema metadata by calling `juxt.jinx.alpha.schema/schema`). + A value may also be a function (called with the URI or, in the case of a regex, the result of the regex match): +