Skip to content

Commit 2f77bea

Browse files
authored
chore(repo): update readme files (#2095)
1 parent 5627b18 commit 2f77bea

15 files changed

Lines changed: 59 additions & 29 deletions

File tree

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,9 @@ This is the high-level architecture of the Iggy message streaming server, where
9090

9191
## Version
9292

93-
The latest released version is `0.4.300` for Iggy server, which is compatible with `0.6` Rust client SDK and the others.
93+
The official releases follow the regular semver (`0.5.0`) or have `latest` tag applied (`apache/iggy:latest`).
9494

95-
The recent improvements based on the zero-copy (de)serialization, along with updated SDKs etc. will be available in the upcoming release with Iggy server `0.5.0`, Rust SDK `0.7` and all the other SDKs.
96-
97-
You can also find the `edge` versions of SDKs that are compatible with the `edge` version of Iggy Server Docker Image, but should be used with caution as these are not based on the official release.
95+
We do also publish edge/dev/nightly releases (e.g. `0.5.0-edge.1` or `apache/iggy:edge`), for both, SDKs and the Docker images, which are typically compatible with the latest changes, but are not guaranteed to be stable, and as the name states, are not recommended for production use.
9896

9997
---
10098

@@ -105,22 +103,22 @@ You can also find the `edge` versions of SDKs that are compatible with the `edge
105103

106104
---
107105

108-
## Supported languages SDK (work in progress)
106+
## Supported languages SDK
107+
108+
- [Rust](https://crates.io/crates/iggy)
109+
- [C#](https://www.nuget.org/packages/Apache.Iggy/)
110+
- [Java](https://repository.apache.org/#nexus-search;quick~iggy)
111+
- [Python](https://pypi.org/project/apache-iggy/)
112+
- [Node.js (TypeScript)](https://www.npmjs.com/package/apache-iggy)
113+
- [Go](https://pkg.go.dev/github.com/apache/iggy/foreign/go)
109114

110-
- Rust
111-
- C#
112-
- Java
113-
- Go
114-
- Python
115-
- Node
116-
- C++
117-
- Elixir
115+
C++ and Elixir are work in progress.
118116

119117
---
120118

121119
## CLI
122120

123-
The brand new, rich, interactive CLI is implemented under the `cli` project, to provide the best developer experience. This is a great addition to the Web UI, especially for all the developers who prefer using the console tools.
121+
The interactive CLI is implemented under the `cli` project, to provide the best developer experience. This is a great addition to the Web UI, especially for all the developers who prefer using the console tools.
124122

125123
Iggy CLI can be installed with `cargo install iggy-cli` and then simply accessed by typing `iggy` in your terminal.
126124

@@ -175,7 +173,9 @@ The [Model Context Protocol](https://modelcontextprotocol.io) (MCP) is an open p
175173

176174
## Docker
177175

178-
The official images can be found in [Docker Hub](https://hub.docker.com/r/apache/iggy), simply type `docker pull apache/iggy` to pull the image.
176+
The official Apache Iggy images can be found in [Docker Hub](https://hub.docker.com/r/apache/iggy), simply type `docker pull apache/iggy` to pull the image.
177+
178+
You can also find the images for all the different tooling such as Connectors, MCP Server etc. [here](https://hub.docker.com/u/apache?page=1&search=iggy).
179179

180180
Please note that the images tagged as `latest` are based on the official, stable releases, while the `edge` ones are updated directly from latest version of the `master` branch.
181181

@@ -313,7 +313,7 @@ let mut producer = client
313313
producer.init().await?;
314314

315315
// Send some messages to the topic
316-
let messages = vec![Message::from_str("Hello Apache Iggy")?];
316+
let messages = vec![IggyMessage::from_str("Hello Apache Iggy")?];
317317
producer.send(messages).await?;
318318

319319
// Create a consumer for the given stream and one of its topics

core/ai/mcp/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,5 @@ Here's the example configuration to be used with Claude Desktop:
6060
```
6161

6262
**Remember to use the appropriate Iggy account credentials for your environment** (e.g. create the user with read-only permissions to avoid modifying the data). On top of this, you can also configure the `permissions` for the MCP server to control which operations are allowed (this will be checked first, before forwarding the actual request to the Iggy server).
63+
64+
![MCP](../../../assets/iggy_mcp_server.png)

core/bench/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Apache Iggy Bench CLI
2+
3+
The interactive Bench CLI allows you to perform various benchmarking on the Apache Iggy server.
4+
5+
Iggy Bench CLI can be installed with `cargo install iggy-bench` and then simply accessed by typing `iggy-bench` in your terminal.
6+
7+
![CLI](../../assets/bench.png)

core/bench/dashboard/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ A modern, high-performance benchmark results dashboard for Iggy, built with Rust
1818
- 🚀 High-performance Rust backend
1919
- ⚡ Fast, modern web frontend built with Yew
2020

21+
![Dashboard](../../../assets/benchmarking_platform.png)
22+
2123
## Project Structure
2224

2325
The project is organized as a Rust workspace with four main components:

core/cli/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Apache Iggy CLI
2+
3+
The interactive CLI allows you to interact with the Apache Iggy server from the command line.
4+
5+
This is a great addition to the Web UI, especially for all the developers who prefer using the console tools.
6+
7+
Iggy CLI can be installed with `cargo install iggy-cli` and then simply accessed by typing `iggy` in your terminal.
8+
9+
![CLI](../../assets/cli.png)

core/connectors/sinks/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ pub trait Sink: Send + Sync {
2727

2828
## Configuration
2929

30-
Sink is configured in the default `config` file used by runtime. Each sink configuration, is part of the map of <String, SinkConfig>, which can be represented using toml, json, or yaml.
30+
Sink is configured in the default `config` file used by runtime. Each sink configuration, is part of the map of `<String, SinkConfig>`, which can be represented using toml, json, or yaml.
3131

3232
```rust
3333
pub struct SinkConfig {

core/connectors/sources/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ pub trait Source: Send + Sync {
2222

2323
## Configuration
2424

25-
Source is configured in the default `config` file used by runtime. Each source configuration, is part of the map of <String, SourceConfig>, which can be represented using toml, json, or yaml.
25+
Source is configured in the default `config` file used by runtime. Each source configuration, is part of the map of `<String, SourceConfig>`, which can be represented using toml, json, or yaml.
2626

2727
```rust
2828
pub struct SourceConfig {

core/server/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Apache Iggy Server
2+
3+
This is the core server component of Apache Iggy. You can run it directly with `cargo run --bin iggy-server --release` or use the Docker image `apache/iggy:latest` (the `edge` tag is for the latest development version).
4+
5+
The configuration file is located at [core/configs/server.toml](https://github.com/apache/iggy/blob/master/core/configs/server.toml). You can customize the server settings by modifying this file or by using environment variables e.g. `IGGY_TCP_ADDRESS=0.0.0.0:8090`.
6+
7+
![Server](../../assets/server.png)
8+
9+
![Architecture](../../assets/iggy_architecture.png)

examples/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Apache Iggy Examples
2+
3+
Here you can find the examples of how to use Apache Iggy with the different programming languages. Please note that the features available in each language may vary.
4+
5+
![Sample](../assets/sample.png)

web/README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
# Apache Iggy (Incubating) Web UI
1+
# Apache Iggy Web UI
22

3-
This proejcts hosts the web user interface for Apache Iggy. The web UI is built using SvelteKit.
3+
This project hosts the web user interface for Apache Iggy. The web UI is built using SvelteKit.
44

5-
![iggy](static/signIn.png)
6-
![iggy](static/stats.png)
7-
![iggy](static/permissions.png)
8-
![iggy](static/streams.png)
9-
![iggy](static/streamsLight.png)
5+
![Web](../assets/web_ui.png)
106

117
## Overview
128

@@ -24,20 +20,20 @@ The Iggy Web UI provides a user-friendly panel for managing various aspects of t
2420
docker run -p 3000:3000 -p 8090:8090 apache/iggy:latest
2521
```
2622

27-
1. **Clone the repository:**
23+
2. **Clone the repository:**
2824

2925
```sh
3026
git clone https://github.com/apache/iggy.git
3127
```
3228

33-
1. **Build the project:**
29+
3. **Build the project:**
3430

3531
```sh
36-
cd iggy-web-ui
32+
cd web
3733
npm install
3834
```
3935

40-
1. **Run the project:**
36+
4. **Run the project:**
4137

4238
```sh
4339
npm run dev

0 commit comments

Comments
 (0)