From eb6a418990c8a5e92774e4dbf1dcc6c38ce26f66 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marko=20Milenkovi=C4=87?=
 <milenkovicm@users.noreply.github.com>
Date: Wed, 15 Nov 2023 09:27:29 +0000
Subject: [PATCH] update readme

---
 Cargo.toml |  4 ++--
 README.md  | 18 +++++++++++++-----
 src/lib.rs |  3 ++-
 3 files changed, 17 insertions(+), 8 deletions(-)

diff --git a/Cargo.toml b/Cargo.toml
index 5c318ba..b606751 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "testcontainers-redpanda-rs"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 license = "MIT"
 description = "Unofficial redpanda test container"
@@ -8,7 +8,7 @@ homepage = "http://github.com/milenkovicm/testcontainers-redpanda-rs"
 repository = "http://github.com/milenkovicm/testcontainers-redpanda-rs"
 readme = "README.md"
 categories = ["development-tools::testing"]
-keywords = ["testcontainers", "testing", "kafka", "docker", "redpanda"]
+keywords = ["testcontainers", "testing", "kafka", "docker", "redpanda", "integration-testing"]
 
 [dependencies]
 log = "0.4"
diff --git a/README.md b/README.md
index 6249fbe..9a2c0f3 100644
--- a/README.md
+++ b/README.md
@@ -2,21 +2,29 @@
 
 Unofficial testcontainer for [Redpanda](https://redpanda.com).
 
+Add dependency:
+
+```toml
+testcontainers-redpanda-rs = "0.1"
+```
+
+Usage example:
+
 ```rust
 use testcontainers::clients;
 use testcontainers_redpanda_rs::*;
 
 let docker = clients::Cli::default();
-let container = Redpanda::default();
+let container = Redpanda::latest();
 
-let server_node = docker.run(container);
+let redpanda_node = docker.run(container);
 // auto create topic is enabled 
 // use this to create topic with specific number
 // of partitions.
-server_node.exec(Redpanda::cmd_create_topic("new_topic_name", 3));
-let bootstrap_servers = format!("localhost:{}", server_node.get_host_port_ipv4(REDPANDA_PORT));
+redpanda_node.exec(Redpanda::cmd_create_topic("new_topic", 3));
+let redpanda_server_address = format!("localhost:{}", redpanda_node.get_host_port_ipv4(REDPANDA_PORT));
 
-println!("bootstrap servers: {}", bootstrap_servers);
+println!("red panda server: {}", redpanda_server_address);
 ```
 
 Current limitations:
diff --git a/src/lib.rs b/src/lib.rs
index 8af267d..c744598 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -4,8 +4,9 @@ use testcontainers::{
     core::{ContainerState, ExecCommand, WaitFor},
     Image, ImageArgs, RunnableImage,
 };
-
+/// Redpanda port
 pub const REDPANDA_PORT: u16 = 9092;
+/// Schema registry port
 pub const SCHEMA_REGISTRY_PORT: u16 = 8081;
 
 #[derive(Debug)]