Skip to content

Commit f582cec

Browse files
committed
Document the readme
1 parent 8d849ef commit f582cec

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
1-
# `openapi-to-validate`
1+
# `openapi-static-validator`
22

33
CLI to compile an OpenAPI specification as JavaScript validation file, optimized for performances.
44

5+
## Installation
6+
7+
```
8+
npm install openapi-static-validator -g
9+
```
10+
11+
## Usage
12+
13+
```
14+
openapi-static-validator spec.json > validate.js
15+
```
16+
517
## TODOs
618

719
- Path/Operations
@@ -17,3 +29,10 @@ CLI to compile an OpenAPI specification as JavaScript validation file, optimized
1729
- [x] `uniqueItems`
1830
- JSONSchema `integer`
1931
- [ ] no float
32+
33+
## Development
34+
35+
To publish the package:
36+
- Change version in `package.json`
37+
- Commit the change and tag it
38+
- Run `npm publish`

0 commit comments

Comments
 (0)