Skip to content

Commit 7ede36a

Browse files
committed
Add feature to readme file
1 parent a67d4db commit 7ede36a

File tree

1 file changed

+32
-13
lines changed

1 file changed

+32
-13
lines changed

README.md

+32-13
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
# AWS IoT Device SDK for Java v2
22

3-
This document provides information about the AWS IoT device SDK for Java V2. This SDK is built on the [AWS Common Runtime](https://docs.aws.amazon.com/sdkref/latest/guide/common-runtime.html)
3+
The **AWS IoT Device SDK for Java v2** is a rewrite of SDK v1 with some great new features. It includes many updates,
4+
such as support for new [AWS IoT Core services](#supported-aws-iot-core-services), more detailed information about client
5+
status, and an offline operation queue control. You can use this SDK using Maven or any build system that supports
6+
MavenCentral as an artifact source.
47

58
*__Jump To:__*
69

7-
* [Installation](#installation)
10+
* [Using SDK](#using-sdk)
11+
* [Features](#features-in-v2)
12+
* [Building from source](#building-from-source)
813
* [Android](./documents/ANDROID.md)
914
* [Samples](samples)
1015
* [Mac-Only TLS Behavior](#mac-only-tls-behavior)
@@ -14,7 +19,7 @@ This document provides information about the AWS IoT device SDK for Java V2. Thi
1419
* [MQTT5 User Guide](./documents/MQTT5_Userguide.md)
1520
* [Migration Guide from the AWS IoT SDK for Java v1](./documents/MIGRATION_GUIDE.md)
1621

17-
## Installation
22+
## Using SDK
1823

1924
### Minimum Requirements
2025

@@ -24,13 +29,6 @@ This document provides information about the AWS IoT device SDK for Java V2. Thi
2429

2530
[Step-by-step instructions](./documents/PREREQUISITES.md)
2631

27-
### Requirements to build the AWS CRT locally
28-
* C++ 11 or higher
29-
* Clang 3.9+ or GCC 4.4+ or MSVC 2015+
30-
* CMake 3.1+
31-
32-
[Step-by-step instructions](./documents/PREREQUISITES.md)
33-
3432
### Consuming IoT Device SDK from Maven in your application
3533

3634
Consuming this SDK via Maven is the preferred method of consuming it and using it within your application. To consume the Java V2 SDK in your application, add the following to your `pom.xml` dependencies:
@@ -43,13 +41,34 @@ Consuming this SDK via Maven is the preferred method of consuming it and using i
4341
</dependency>
4442
```
4543

46-
Replace `1.25.0` in `<version>1.25.0</version>` with the latest release version for the SDK.
47-
Look up the latest SDK version here: https://github.com/aws/aws-iot-device-sdk-java-v2/releases
44+
## Features in v2
45+
46+
* All operations are non-blocking.
47+
* MQTT5 protocol.
48+
* First-class support for AWS IoT Core services.
4849

49-
### Build IoT Device SDK from source
50+
#### Supported AWS IoT Core services
51+
52+
* The [AWS IoT Device Shadow](https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html) service adds
53+
shadows to AWS IoT thing objects.
54+
* The [AWS IoT Jobs](https://docs.aws.amazon.com/iot/latest/developerguide/iot-jobs.html) allows to define a set of remote
55+
operations that can be sent to and run on one or more devices connected to AWS IoT.
56+
* [Fleet Provisioning](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html) (also known as Identity
57+
Service) is another AWS IoT service that the v2 SDK provides access to. By using AWS IoT fleet provisioning, AWS IoT can
58+
generate and securely deliver device certificates and private keys to your devices when they connect to AWS IoT for the
59+
first time.
60+
61+
## Building from source
62+
63+
Requirements to build the AWS CRT locally
64+
* C++ 11 or higher
65+
* Clang 3.9+ or GCC 4.4+ or MSVC 2015+
66+
* CMake 3.1+
5067

5168
[Install Maven and Set PATH](https://maven.apache.org/install.html)
5269

70+
See [step-by-step instructions](./documents/PREREQUISITES.md) for more details on configuring required tools.
71+
5372
``` sh
5473
# Create a workspace directory to hold all the SDK files
5574
mkdir sdk-workspace

0 commit comments

Comments
 (0)