Skip to content

Commit

Permalink
add readme and release 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
yuhao-su authored May 8, 2024
1 parent 02ed0e1 commit 12db08c
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 8 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
[package]
name = "aws-msk-iam-sasl-signer"
version = "0.1.0"
version = "1.0.0"
edition = "2021"
license = "Apache-2.0"
authors = ["Yuhao Su<[email protected]>"]
description = "AWS MSK IAM SASL Signer"
repository = "https://github.com/yuhao-su/aws-msk-iam-sasl-signer-rs"
homepage = "https://github.com/yuhao-su/aws-msk-iam-sasl-signer-rs"
readme = "README.md"
keywords = ["aws", "msk", "kafka", "sasl", "iam"]
categories = ["authentication"]
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
Expand Down
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# AWS MSK IAM SASL Signer for Go

[![CI status](https://github.com/yuhao-su/aws-msk-iam-sasl-signer-rs/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/yuhao-su/aws-msk-iam-sasl-signer-rs/actions/workflows/ci.yaml)
[![Apache V2 License](https://img.shields.io/badge/license-Apache%20V2-blue.svg)](./LICENSE)

`aws-msk-iam-sasl-signer-rs` is a AWS MSK IAM SASL signer for Rust. It is a port of the [aws-msk-iam-sasl-signer-go](https://github.com/aws/aws-msk-iam-sasl-signer-go).

## Usage
add the following to your `Cargo.toml`:
```toml
[dependencies]
aws-msk-iam-sasl-signer = "1.0.0"
```

## Example
check the [producer example](./examples/consumer.rs) and [consumer example](./examples/producer.rs) for more details.

## License
This library is licensed under the [Apache 2.0 License](./LICENSE).

0 comments on commit 12db08c

Please sign in to comment.