Adding docs dir

This commit is contained in:
Chris Troutner
2019-06-18 13:25:19 -07:00
parent 57a9972298
commit 2f26b39fea
2 changed files with 7 additions and 1 deletions
+1
View File
@@ -0,0 +1 @@
This directory holds api docs generated by apidoc.
+6 -1
View File
@@ -15,7 +15,8 @@
"test-v3": "export NETWORK=testnet && nyc --reporter=text mocha --timeout 25000 test/v3/",
"test:integration": "mocha test/v3/integration",
"coverage": "nyc report --reporter=text-lcov | coveralls",
"coverage:report": "export NETWORK=testnet && nyc --reporter=html mocha test/v2/"
"coverage:report": "export NETWORK=testnet && nyc --reporter=html mocha test/v2/",
"docs": "./node_modules/.bin/apidoc -i src/ -o docs"
},
"engines": {
"node": ">=10.15.1"
@@ -83,5 +84,9 @@
"npmPublish": false
}
]
},
"apidoc": {
"title": "bch-api",
"url": "localhost:3000"
}
}