Skip to content

Commit 0ed5b4b

Browse files
authored
Merge pull request #40 from chaijs/feature/update-README
Bump to version 1.4 and update history section in README.md
2 parents 4e2a840 + 11afc0a commit 0ed5b4b

File tree

2 files changed

+9
-19
lines changed

2 files changed

+9
-19
lines changed

README.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
[![dependencies:?](https://img.shields.io/david/chaijs/chai-json-schema.svg?style=flat-square)](https://david-dm.org/chaijs/chai-json-schema)
77
[![devDependencies:?](https://img.shields.io/david/dev/chaijs/chai-json-schema.svg?style=flat-square)](https://david-dm.org/chaijs/chai-json-schema)
88

9-
> [Chai](http://chaijs.com/) plugin with assertions to validate values against [JSON Schema v4](http://json-schema.org/).
9+
> [Chai](http://chaijs.com/) plugin with assertions to validate values against [JSON Schema v4](http://json-schema.org/).
1010
11-
Assert both simple values and complex objects with the rich collection of [validation terms](http://json-schema.org/latest/json-schema-validation.html) ([examples](http://json-schema.org/examples.html)).
11+
Assert both simple values and complex objects with the rich collection of [validation terms](http://json-schema.org/latest/json-schema-validation.html) ([examples](http://json-schema.org/examples.html)).
1212

1313
For general help with json-schema see this excellent [guide](http://spacetelescope.github.io/understanding-json-schema/) and usable [reference](http://spacetelescope.github.io/understanding-json-schema/reference/index.html).
1414

@@ -113,7 +113,7 @@ assert.notJsonSchema(badApple, fruitSchema);
113113

114114
## Additional API
115115

116-
The `tv4` instance is 'exported' as `chai.tv4` and can be accessed to add schemas for use in validations:
116+
The `tv4` instance is 'exported' as `chai.tv4` and can be accessed to add schemas for use in validations:
117117

118118
````js
119119
chai.tv4.addSchema(uri, schema);
@@ -134,9 +134,9 @@ var schema = chai.tv4.getSchema('http://example.com/item/#sub/type');
134134
chai.tv4.dropSchemas();
135135
````
136136

137-
For more API methods and info on the validator see the [tv4 documentation](https://github.com/geraintluff/tv4#api).
137+
For more API methods and info on the validator see the [tv4 documentation](https://github.com/geraintluff/tv4#api).
138138

139-
### Non-standard tv4 properties
139+
### Non-standard tv4 properties
140140

141141
**Cyclical objects**
142142

@@ -146,7 +146,7 @@ This will be passed to the internal `tv4` validate call to enable [support for c
146146
chai.tv4.cyclicCheck = true;
147147
````
148148

149-
This is slightly slower then regular validation so it is disabled by default.
149+
This is slightly slower then regular validation so it is disabled by default.
150150

151151
**Ban unknown properties**
152152

@@ -172,7 +172,7 @@ Due to the synchronous nature of assertions there will be no support for dynamic
172172
Use the asynchronous preparation feature of your favourite test runner to preload remote schemas:
173173

174174
````js
175-
// simplified example using a bdd-style async before();
175+
// simplified example using a bdd-style async before();
176176
// as used in mocha, jasmine etc.
177177

178178
before(function (done) {
@@ -216,16 +216,7 @@ before(function (done) {
216216
````
217217

218218
## History
219-
220-
* 1.2.0 - Dependency update - Chai 2.x
221-
* 1.1.0 - Dependency update
222-
* 1.0.10 - AMD loader support
223-
* 1.0.9 - Published to bower.
224-
* 1.0.7 - Updated tv4 dependency, improved error formatting.
225-
* 1.0.5 - Dropped underscore dependency, various internal tweaks.
226-
* 1.0.4 - Use and expose separated tv4 instance. Improved readme examples.
227-
* 1.0.3 - Published to [chaijs.com/plugins](http://chaijs.com/plugins)
228-
* 1.0.2 - Improved reporting, made compatible with standard reporters.
219+
See [Releases](https://github.com/chaijs/chai-json-schema/releases).
229220

230221
## Build
231222

@@ -256,4 +247,3 @@ Copyright (c) 2013 Bart van der Schoor
256247
Licensed under the MIT license.
257248

258249
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/Bartvds/chai-json-schema/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
259-

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "chai-json-schema",
3-
"version": "1.3.0",
3+
"version": "1.4.0",
44
"description": "Chai plugin for JSON Schema v4",
55
"author": {
66
"name": "Bart van der Schoor",

0 commit comments

Comments
 (0)