Skip to content

add note to samples readme about install from npm #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 28, 2020
Merged

add note to samples readme about install from npm #89

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d63f6af
add note to samples readme about install from npm
TingDaoK Aug 28, 2020
a607bfd
grammar
TingDaoK Aug 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,25 @@
# Samples

## Note

If you are installing via npm instead of building from source, please make the following change to the package.json under each sample.

``` json
From:
"dependencies": {
"aws-iot-device-sdk-v2": "../../../",
"yargs": "^14.0.0"
}

To:
"dependencies": {
"aws-iot-device-sdk-v2": "<latest released version eg: ^1.3.0>",
"yargs": "^14.0.0"
}
```

## node/pub_sub

This sample uses the
[Message Broker](https://docs.aws.amazon.com/iot/latest/developerguide/iot-message-broker.html)
for AWS IoT to send and receive messages
Expand Down