update docs

milenkovicm · May 29, 2024 · 72ed3dd · 72ed3dd
1 parent 65a060f
commit 72ed3dd
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "testcontainers-redpanda-rs"
-version = "0.3.0"
+version = "0.3.1"
 edition = "2021"
 license = "MIT"
 description = "Unofficial redpanda test container"

diff --git a/README.md b/README.md
@@ -4,18 +4,19 @@
 [![Crates.io](https://img.shields.io/crates/v/testcontainers-redpanda-rs)](https://crates.io/crates/testcontainers-redpanda-rs)
 [![Crates.io](https://img.shields.io/crates/d/testcontainers-redpanda-rs)](https://crates.io/crates/testcontainers-redpanda-rs)
 
-Unofficial testcontainer for [Redpanda](https://redpanda.com).
+Unofficial testcontainer for [Redpanda](https://redpanda.com). Redpanda is a simple, powerful, and cost-efficient streaming data platform that is compatible with Kafka APIs but much less complex, faster and more affordable.
 
 Note:
 
+- version `0.3.x` supports `testcontainer` `0.17`
 - version `0.2.x` supports `testcontainer` `0.16`
 - version `0.1.x` supports `testcontainer` `0.15`
 
 Add dependency:
 
 ```toml
-testcontainers-redpanda-rs = { version = "0.2" }
-testcontainers = { version = "0.16" }
+testcontainers-redpanda-rs = { version = "0.3" }
+testcontainers = { version = "0.17" }
 ```
 
 Create and run redpanda container:
@@ -31,8 +32,7 @@ async fn main() {
     let bootstrap_servers = format!("localhost:{}", server_node.get_host_port_ipv4(REDPANDA_PORT).await.unwrap());
     // if topic has only one partition this part is optional
     // it will be automatically created when client connects
-    let test_topic_name = "test_topic";
-    server_node.exec(Redpanda::cmd_create_topic(test_topic_name, 3)).await.unwrap();
+    server_node.exec(Redpanda::cmd_create_topic("test_topic", 3)).await.unwrap();
 
     println!("Redpanda server: {}", bootstrap_servers);
 }