# Amanda
[Amanda](https://github.com/Baggz/Amanda) is aiming to be **an universal validation library**. Currently it supports only the [JSON Schema Internet Draft](http://tools.ietf.org/html/draft-zyp-json-schema-03), but I'm planning to add [Orderly](http://orderly-json.org/), [Relax NG](http://relaxng.org/) and others very soon.
#### Example
```javascript
/**
* Schema
*/
var schema = {
type: 'object',
properties: {
name: {
required: true,
type: 'string',
length: 7
}
}
};
/**
* Data
*/
var data = {
name: 'Kenneth'
};
// Initialize a JSON Schema validator
var jsonSchemaValidator = amanda('json');
// Validate the data against the schema
jsonSchemaValidator.validate(data, schema, function(error) {
// Do something...
});
```
#### Features
* **Extendable**, you can create **your own attributes**
* Can be used with **Node.js** and **in a browser**
* Amanda has **no dependencies**
* **AMD compatible**, you can load it via [RequireJS](https://github.com/jrburke/requirejs)
* Lightweight
* Fully **documented**
* Tested
#### Status
| **Branch** | **Status** |
|:-----------|:----------|
| master | [](http://travis-ci.org/Baggz/Amanda) |
| dev | [](http://travis-ci.org/Baggz/Amanda) |
### Contents
## Download [↑](#Contents)
To install **Amanda**, use [NPM](http://npmjs.org/).
```
$ npm install amanda
```
Releases for a browser are available for download from GitHub.
| **Version** | **Description** | **Size** | **Action** |
|:------------|:----------------|:---------|:-----------|
| `amanda.js` | *uncompressed, with comments* | 36.01 KB (7.11 KB gzipped) | [Download](https://raw.github.com/Baggz/Amanda/master/releases/latest/amanda.js) |
| `amanda.min.js` | *compressed, without comments* | 13.62 KB (3.99 KB gzipped) | [Download](https://raw.github.com/Baggz/Amanda/master/releases/latest/amanda.min.js) |
## Usage [↑](#Contents)
### Browser
```
```
### Node.js, RingoJS, Narwhal
```javascript
var amanda = require('amanda');
```
### RequireJS
```javascript
// Configuration options, the path should not include the .js extension
require.config({
paths: {
"robb": "path/to/amanda"
}
});
// Load Amanda
require(['amanda'], function(amanda) {
// Do something...
});
```
## Documentation [↑](#Contents)
All documentation is available in the [/docs/](https://github.com/Baggz/Amanda/tree/master/examples) folder.
## Compatibility [↑](#Contents)
### Node.js
From version **0.6.0**.
***Note:** Earlier versions might work OK, but are not tested.*
### Browsers
*Testing in progress...*
## Building [↑](#Contents)
I have included a `Makefile` with convenience methods for working with the library.
## Tests [↑](#Contents)
```
$ npm test
```
## Versioning [↑](#Contents)
Releases will be numbered with the following format.
```
..
```
And constructed with the following guidelines.
* Breaking backwards compatibility bumps the major
* New additions without breaking backwards compatibility bumps the minor
* Bug fixes and misc changes bump the patch
For more information on *semantic versioning*, please visit http://semver.org/.
## Release Notes [↑](#Contents)
* [v0.4.0](https://github.com/Baggz/Amanda/pull/35)
* [v0.3.0](https://github.com/Baggz/Amanda/pull/26)
* [v0.2.2](https://github.com/Baggz/Amanda/pull/15)
* [v0.2.1](https://github.com/Baggz/Amanda/pull/3)
* [v0.2.0](https://github.com/Baggz/Amanda/pull/2)
* [v0.0.2](https://github.com/Baggz/Amanda/pull/1)
## Contributors [↑](#Contents)
The following are the major contributors of Amanda (in random order).
* **František Hába** ([@Baggz](https://github.com/Baggz))
* **Jakub Nešetřil** ([@zzen](https://github.com/zzen))
* **Iain Carsberg** ([@iaincarsberg](https://github.com/iaincarsberg))
* **Adrian Rossouw** ([@Vertice](https://github.com/Vertice))
* **Leon de Almeida** ([@leondealmeida](https://github.com/leondealmeida))
## License [↑](#Contents)
(The MIT License)
Copyright (c) 2011 František Hába <hello@frantisekhaba.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.