Skip to content

Commit 0c1ea0d

Browse files
committed
Add docs stub
1 parent 4938188 commit 0c1ea0d

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

docs/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# OpenAPI-CodeGen
2+
3+
## Documentation
4+
5+
### Config file DSL
6+
7+
#### Example
8+
9+
```json
10+
{
11+
"defaults": {
12+
"exampleProperty": "exampleValue"
13+
},
14+
"directories": [
15+
"docs", "docs/assets", "docs/assets/css", "docs/assets/js", "docs/assets/images"
16+
],
17+
"partials": {
18+
"model": "model.mustache",
19+
"operation": "operation.mustache"
20+
},
21+
"transformations": [
22+
{ "input": "index.mustache", "output": "docs/index.html" },
23+
]
24+
}
25+
```

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
"version": "1.1.0",
44
"description": "OpenAPI 3.0 CodeGen",
55
"main": "index.js",
6+
"bin": {
7+
"cg": "./cg.js"
8+
},
69
"scripts": {
710
"test": "echo \"Error: no test specified\" && exit 1"
811
},

0 commit comments

Comments
 (0)