Skip to content

Commit

Permalink
docs(api): commit docs for github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
reconbot committed Feb 15, 2018
1 parent 2da025e commit 792459d
Show file tree
Hide file tree
Showing 31 changed files with 11,821 additions and 4 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,3 @@ npm-debug.log
package-lock.json
Release/
prebuilds/
docs
2 changes: 1 addition & 1 deletion .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ test-config.json
UPGRADE_GUIDE.md
changelog.md
.DS_Store
docs

# MIRRORED FROM .gitignore PLEASE MAINTAIN
.mailmap
Expand All @@ -27,4 +28,3 @@ node_modules
npm-debug.log
package-lock.json
Release/
docs
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ For a full breakdown of why we made Node-Serialport, please read [NodeBots - The
We're not against firmware but we're better than it.

## Quick Answers to Important Questions
- [**API Docs**](https://doclets.io/node-serialport/node-serialport/)
- [**API Docs**](https://node-serialport.github.io/node-serialport/)
- **For support**, open a [GitHub issue](https://github.com/node-serialport/node-serialport/issues/new).
- **For discussions, design ideas, and clarifications**, please join our [Gitter chat room](https://gitter.im/EmergingTechnologyAdvisors/node-serialport).
- **To test Node-Serialport**, we recommend two related projects—[Browser Serialport](https://github.com/garrows/browser-serialport) ("just like Node Serialport, but for browser apps") and [Serialport Test Piliot](https://github.com/j5js/serialport-test-pilot).
Expand All @@ -29,7 +29,7 @@ We're not against firmware but we're better than it.

## API Documentation

Can be found at https://doclets.io/node-serialport/node-serialport/
Can be found at https://node-serialport.github.io/node-serialport/

See our [changelog](CHANGELOG.md) for what's new, and our [upgrade guide](UPGRADE_GUIDE.md) for a walk-through on differences between major versions.

Expand Down
Loading

0 comments on commit 792459d

Please sign in to comment.