diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..dcaa432 --- /dev/null +++ b/docs/README.md @@ -0,0 +1 @@ +This directory holds api docs generated by apidoc. diff --git a/package.json b/package.json index cbeaf53..c54a260 100644 --- a/package.json +++ b/package.json @@ -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" } }