diff --git a/samples/README.md b/samples/README.md index daaea338..ae3a616f 100644 --- a/samples/README.md +++ b/samples/README.md @@ -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": "", + "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