Skip to content

Commit d23aba1

Browse files
authored
Improve README titles and add TOC to samples README (#91)
1 parent 2820104 commit d23aba1

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AWS IoT SDK for Javascript v2
1+
# AWS IoT Device SDK for JavaScript v2
22
This document provides information about the AWS IoT device SDK for Javascript V2.
33

44
If you have any issues or feature requests, please file an issue or pull request.
@@ -27,7 +27,7 @@ to JS by the [awscrt](https://github.com/awslabs/aws-crt-nodejs) package.
2727
* Node 10.x+
2828

2929
### Common Run Time
30-
The aws-crt package can be installed via npm
30+
The aws-crt package can be installed via npm
3131
```
3232
npm install aws-crt
3333
```

samples/README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Samples
1+
# Sample apps for the AWS IoT Device SDK for JavaScript v2
2+
3+
* [pubsub](#nodepub_sub)
4+
* [fleet provisioning](#fleet-provisioning)
5+
* [basic discovery](#nodebasic_discovery)
26

37
## Note
48

@@ -80,11 +84,6 @@ and receive.
8084
</pre>
8185
</details>
8286

83-
## node/basic_discovery
84-
85-
This sample intended for use directly with the
86-
[Getting Started with AWS IoT Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-gs.html) guide.
87-
8887
## fleet provisioning
8988

9089
This sample uses the AWS IoT
@@ -155,4 +154,9 @@ and receive.
155154
]
156155
}
157156
</pre>
158-
</details>
157+
</details>
158+
159+
## node/basic_discovery
160+
161+
This sample intended for use directly with the
162+
[Getting Started with AWS IoT Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-gs.html) guide.

0 commit comments

Comments
 (0)