Skip to content

Commit

Permalink
Add link to API documentation. Add npm script to publish API document…
Browse files Browse the repository at this point in the history
…ation.
  • Loading branch information
francisbrito committed May 12, 2018
1 parent 32e0574 commit e803d05
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ start()

## API

Coming soon.
API documentation is hosted [here](https://xrps.github.io/fcm-token-registry/).

## Examples

Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
"test-with-coveralls": "nyc ava && nyc report --reporter=text-lcov | coveralls",
"start": "node lib/scripts/start",
"watch-restart": "nodemon lib/scripts/start",
"generate-docs": "jsdoc --readme README.md --recurse --package package.json {index,lib/**/*}.js"
"generate-docs": "jsdoc --readme README.md --recurse --package package.json {index,lib/**/*}.js",
"publish-docs": "gh-pages -d ./out/docs -s './**/*.*' -o upstream"
},
"keywords": [
"fcm",
Expand Down

0 comments on commit e803d05

Please sign in to comment.