api in readme

README.md

@@ -1,6 +1,6 @@
 # ajv - Another JSON Schema Validator
 
-One of the fastest JSON Schema validators. It uses [doT templates](https://github.com/olado/doT) to generate super-fast validating functions.
+One of the fastest JSON Schema validators for node.js. It uses [doT templates](https://github.com/olado/doT) to generate super-fast validating functions.
 
 
 ## JSON Schema standard
@@ -8,21 +8,13 @@ One of the fastest JSON Schema validators. It uses [doT templates](https://githu
 ajv implements full [JSON Schema draft 4](http://json-schema.org/) standard:
 
 - all validation keywords
-- full support of remote refs (remote schemas have to be pre-loaded)
+- full support of remote refs (remote schemas have to be added with `addSchema` or compiled to be available)
 - correct string lengths for strings with unicode pairs (can be turned off)
 - formats defined by JSON Schema draft 4 standard (can be turned off)
 
 ajv passes all the tests from [JSON Schema Test Suite](https://github.com/json-schema/JSON-Schema-Test-Suite) (apart from the one that requires that `1.0` is not an integer).
 
 
-## TODO
-
-- resolve missing remote refs when schemas are added
-- custom formats (via options)
-- schema validation before compilation
-- bundle compiled templates (doT will be dev dependency)
-
-
 ## Install
 
 ```
@@ -33,7 +25,8 @@ npm install ajv
 ## Usage
 
 ```
-var ajv = require('ajv')(options);
+var Ajv = require('ajv');
+var ajv = Ajv(); // options can be passed
 var validate = ajv.compile(schema);
 var valid = validate(data);
 if (!valid) console.log(validate.errors);
@@ -47,16 +40,63 @@ var valid = ajv.validate(schema, data);
 // ...
 ```
 
+or
+
+```
+// ...
+ajv.addSchema(schema, 'mySchema');
+var valid = ajv.validate('mySchema', data);
+// ...
+```
+
 ajv compiles schemas to functions and caches them in both cases (using stringified schema as a key - using [json-stable-stringify](https://github.com/substack/json-stable-stringify)), so that the next time the same schema is used (not necessarily the same object instance) it won't be compiled again.
 
 
+## API
+
+### Ajv(Object options) -> Object
+
+Create ajv instance.
+
+
+### .compile(Object schema) -> Function<Object data>
+
+Generate validating function and cache compiled schema for future use.
+
+
+### .validate(Object schema|String key|String ref, data) -> Boolean
+
+Validate data using passed schema (it will be compiled and cached).
+
+Instead of the schema you can use the key that was previously passed to `addSchema` or a previously resolved reference.
+
+
+### .addSchema(Array schemas|Object schema [, String key]) -> Function<Object data>
+
+Add and compile schema(s). It does the same as `.compile` with two differences:
+
+- array of schemas can be passed (schemas should have ids), the second parameter will be ignored.
+
+- key can be passed that can be used to reference the schema and will be used as the schema id if there is no id inside the schema. If the key is not passed, the schema id will be used as the key.
+
+
+Once the schema added it and all the references inside it can be referenced in other schemas and used to validate data.
+
+In the current version all the referenced schemas should be added before the schema that uses them is compiled, so the circular references are not supported.
+
+
+### .getSchema(String key) -> Function<Object data>
+
+Retrieve schema previously added with `addSchema`. Validating function has `schema` property with the reference to the original schema.
+
+
 ## Options
 
 - _allErrors_: check all rules collecting all errors. Default is to return after the first error.
 - _verbose_: include the reference to the part of the schema and validated data in errors (false by default).
 - _format_: validate formats (true by default).
 - _meta_: add [meta-schema](http://json-schema.org/documentation.html) so it can be used by other schemas (true by default).
-- _uniqueItems_: validate `uniqueItems` (true by default).
+- _uniqueItems_: validate `uniqueItems` keyword (true by default).
 - _unicode_: calculate correct length of strings with unicode pairs (true by default). Pass `false` to use `.length` of strings that is faster, but gives "incorrect" lengths of strings with unicode pairs - each unicode pair is counted as two characters.
 - _beautify_: format the generated function with [js-beautify](https://github.com/beautify-web/js-beautify) (the validating function is generated without line-breaks). `npm install js-beautify` to use this option. `true` or js-beautify options can be passed.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ajv",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Another JSON schema Validator",
   "main": "lib/ajv.js",
   "scripts": {