Skip to content

Commit a3a26d7

Browse files
author
John Doherty
committed
updated docs
1 parent c9e67ba commit a3a26d7

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.MD

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
# jsdoc-to-json-schema
2+
23
[![npm](https://img.shields.io/npm/dt/jsdoc-to-json-schema.svg)](https://www.npmjs.com/package/jsdoc-to-json-schema) [![Linked In](https://img.shields.io/badge/Linked-In-blue.svg)](https://www.linkedin.com/in/john-i-doherty) [![Twitter Follow](https://img.shields.io/twitter/follow/CambridgeMVP.svg?style=social&label=Twitter&style=plastic)](https://twitter.com/CambridgeMVP)
34

45
Generate JSON schemas from JavaScript comments using a new jsDoc *@schema* tag.
56

67
## Installation
78

89
```js
9-
npm install jsdoc-to-json-schema --save
10+
npm install --save jsdoc-to-json-schema
1011
```
1112

12-
## Usage
13+
## Example
1314

14-
As a node module
15+
Using jsdoc-to-json-schema as a node module:
1516

1617
```js
1718
var toJsonSchema = require('jsdoc-to-json-schema');
@@ -20,7 +21,7 @@ var toJsonSchema = require('jsdoc-to-json-schema');
2021
toJsonSchema('./example/product.js', './example/product.schema.json');
2122
```
2223

23-
via the command line
24+
Using jsdoc-to-json-schema via the command line:
2425

2526
```
2627
$ jsdoc-to-json-schema -i ./example/product.js -o ./example/product.schema.json
@@ -207,4 +208,4 @@ The following [JSON Schema v3](https://tools.ietf.org/html/draft-zyp-json-schema
207208

208209
## License
209210

210-
[ISC License](LICENSE) © 2016 [John Doherty](https://twitter.com/CambridgeMVP)
211+
Licensed under [ISC License](LICENSE) © [John Doherty](http://www.johndoherty.info)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "jsdoc-to-json-schema",
3-
"version": "0.1.1",
3+
"version": "0.1.2",
44
"description": "Generate JSON Schema from jsDoc comments.",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)