Skip to content

Commit 2da3953

Browse files
authored
chore: update readme (#739)
1 parent 2b63da9 commit 2da3953

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ This repo contains the AWS SDK for Kotlin and its [public roadmap](https://githu
1414

1515
## Getting Started
1616

17+
* [SDK Homepage](https://aws.amazon.com/sdk-for-kotlin/)
18+
* [Developer Guide](https://docs.aws.amazon.com/sdk-for-kotlin/latest/developer-guide/home.html)
19+
* [API Reference](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
20+
* [Samples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin)
21+
1722
See the [Getting Started Guide](docs/GettingStarted.md) to learn how to use AWS SDKs in your program.
1823

1924
## Feedback
@@ -154,14 +159,6 @@ kotlin.mpp.hierarchicalStructureSupport=false
154159

155160
See [Debugging](docs/debugging.md)
156161

157-
## Getting Help
158-
159-
Use the following sources for information:
160-
161-
* [Check api and developer guides.](https://docs.aws.amazon.com/sdk-for-kotlin/index.html)
162-
* Check for similar [issues](https://github.com/awslabs/aws-sdk-kotlin/issues) already opened.
163-
164-
If you still can’t find a solution to your problem open an [issue](https://github.com/awslabs/aws-sdk-kotlin/issues/new/choose) or a [discussion](https://github.com/awslabs/aws-sdk-kotlin/discussions/new)
165162

166163
## Security
167164

docs/GettingStarted.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Consult the [stability guide](stability.md) for more information on SDK stabilit
2323
# file: my-project/build.gradle.kts
2424

2525
dependencies {
26-
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.0")
26+
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.3")
2727

2828
// The following line adds a dependency on the dynamodb client.
2929
implementation("aws.sdk.kotlin:dynamodb:0.+")
@@ -37,9 +37,10 @@ Consult the [stability guide](stability.md) for more information on SDK stabilit
3737
```kotlin
3838
import kotlinx.coroutines.runBlocking
3939
import aws.sdk.kotlin.services.dynamodb.DynamoDbClient
40+
import aws.sdk.kotlin.services.dynamodb.listTables
4041

4142
fun main() = runBlocking {
42-
val client = DynamoDbClient { region = "us-east-2" }
43+
val client = DynamoDbClient.fromEnvironment()
4344
val resp = client.listTables { limit = 10 }
4445

4546
println("Current DynamoDB tables: ")
@@ -54,6 +55,6 @@ Consult the [stability guide](stability.md) for more information on SDK stabilit
5455
## Additional Resources
5556

5657
* [Additional examples](https://github.com/awslabs/aws-sdk-kotlin/tree/main/examples)
57-
* [Giving feedback and contributing](https://github.com/awslabs/aws-sdk-kotlin#feedback)
58+
* [Getting started](https://github.com/awslabs/aws-sdk-kotlin#getting-started)
5859
* [Debugging](debugging.md)
5960
* [Android support](targets.md#android)

0 commit comments

Comments
 (0)