Skip to content

Commit

Permalink
misc: update documentation and bump version (#1137)
Browse files Browse the repository at this point in the history
  • Loading branch information
lauzadis authored Nov 26, 2023
1 parent b6f1880 commit ddd68e1
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 12 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@
[maven-badge]: https://img.shields.io/maven-central/v/aws.sdk.kotlin/s3.svg?label=Maven
[maven-url]: https://search.maven.org/search?q=g:aws.sdk.kotlin

This repo contains the AWS SDK for Kotlin and its [public roadmap](https://github.com/awslabs/aws-sdk-kotlin/projects/2)

**The AWS SDK for Kotlin is currently in developer preview and is intended strictly for feedback purposes only. Do not use this SDK for production workloads. Refer to the SDK [stability](VERSIONING.md#stability-of-the-aws-sdk-for-kotlin) guidelines**
This repo contains the AWS SDK for Kotlin and its [public roadmap](https://github.com/awslabs/aws-sdk-kotlin/projects/2).

## Getting Started

Expand All @@ -19,7 +17,7 @@ This repo contains the AWS SDK for Kotlin and its [public roadmap](https://githu
* [API Reference](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
* [Samples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin)

See the [Getting Started Guide](docs/GettingStarted.md) to learn how to use AWS SDKs in your program.
See the [Getting Started Guide](docs/GettingStarted.md) to learn how to use the AWS SDK for Kotlin in your program.

## Feedback

Expand Down
8 changes: 4 additions & 4 deletions docs/GettingStarted.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Beta Release Quickstart
# Getting Started

Beta releases of the AWS SDK for Kotlin are published to Maven Central with the `-beta` qualifier.
**NOTE: Beta releases are not meant for production workloads**.
Releases of the AWS SDK for Kotlin are published to Maven Central .
**NOTE: Beta releases ending with the `-beta` qualifier are not meant for production workloads**.
Consult the [stability guide](../VERSIONING.md#stability-of-the-aws-sdk-for-kotlin) for more information on SDK stability and maintenance.

1. Add the repository to your Gradle or Maven configuration
Expand All @@ -26,7 +26,7 @@ Consult the [stability guide](../VERSIONING.md#stability-of-the-aws-sdk-for-kotl
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.3")

// The following line adds a dependency on the dynamodb client.
implementation("aws.sdk.kotlin:dynamodb:0.+")
implementation("aws.sdk.kotlin:dynamodb:1.+")
}
```

Expand Down
2 changes: 1 addition & 1 deletion examples/gradle.properties
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@

# AWS SDK
awsSdkKotlinVersion=0.+
awsSdkKotlinVersion=1.+
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true
org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G

# sdk
sdkVersion=0.37.0-SNAPSHOT
sdkVersion=1.0.0-SNAPSHOT

# kotlin
kotlinVersion=1.9.20
Expand Down
4 changes: 2 additions & 2 deletions gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ coroutines-version = "1.7.3"
atomicfu-version = "0.22.0"

# smithy-kotlin codegen and runtime are versioned separately
smithy-kotlin-runtime-version = "0.30.0"
smithy-kotlin-codegen-version = "0.30.0"
smithy-kotlin-runtime-version = "1.0.0"
smithy-kotlin-codegen-version = "0.30.1"

# codegen
smithy-version = "1.41.1"
Expand Down

0 comments on commit ddd68e1

Please sign in to comment.