Skip to content

Commit

Permalink
documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Wicker committed Oct 8, 2015
1 parent 9ccb849 commit b09fbea
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,18 @@ environments as well.
* [Support](#support)

<a name="overview"></a>
##Overview
## Overview
This document provides instructions on how to install and configure the AWS
IoT device SDK for Node.js and includes examples demonstrating use of the
SDK APIs.

###MQTT connection
### MQTT connection
This package is built on top of mqtt.js and provides two classes: 'device'
and 'thingShadow'. The 'device' class loosely wraps mqtt.js to provide a
secure connection to the AWS IoT platform and expose the mqtt.js interfaces
upward via an instance of the mqtt client.

###Thing Shadows
### Thing Shadows
The 'thingShadow' class implements additional functionality for accessing Thing Shadows via the AWS IoT
API; the thingShadow class allows devices to update, be notified of changes to,
get the current state of, or delete Thing Shadows from AWS IoT. Thing
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "aws-iot-device-sdk",
"description": "AWS IoT JavaScript SDK for Embedded Devices",
"version": "1.0.0",
"version": "1.0.2",
"author": {
"name":"Amazon Web Services",
"email":"",
Expand Down

0 comments on commit b09fbea

Please sign in to comment.