Skip to content

Commit 0d9e7ce

Browse files
authored
add note to samples readme about install from npm (#89)
*Issue #, if available:* #88 If you install the package via npm, the relative path will not work However, we don't want to the version under the samples get behind of the current release. *Description of changes:* - Add note to README Co-authored-by: Dengke Tang <[email protected]>
1 parent bec1d87 commit 0d9e7ce

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

samples/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
# Samples
22

3+
## Note
4+
5+
If you are installing via npm instead of building from source, please make the following change to the package.json under each sample.
6+
7+
``` json
8+
From:
9+
"dependencies": {
10+
"aws-iot-device-sdk-v2": "../../../",
11+
"yargs": "^14.0.0"
12+
}
13+
14+
To:
15+
"dependencies": {
16+
"aws-iot-device-sdk-v2": "<latest released version eg: ^1.3.0>",
17+
"yargs": "^14.0.0"
18+
}
19+
```
20+
321
## node/pub_sub
22+
423
This sample uses the
524
[Message Broker](https://docs.aws.amazon.com/iot/latest/developerguide/iot-message-broker.html)
625
for AWS IoT to send and receive messages

0 commit comments

Comments
 (0)