Skip to content

Commit 407d678

Browse files
authored
Update readme
1 parent 8cfc55b commit 407d678

File tree

4 files changed

+36
-17
lines changed

4 files changed

+36
-17
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@
2626
- [ ] New and existing unit tests pass locally with my changes
2727
- [ ] Any dependent changes have been merged
2828

29-
Check out [Contributing](https://github.com/kafbat/kafka-ui/blob/main/CONTRIBUTING.md) and [Code of Conduct](https://github.com/kafbat/kafka-ui/blob/main/CODE-OF-CONDUCT.md)
29+
Check out [Contributing](https://github.com/kafbat/kafka-ui/blob/main/.github/CONTRIBUTING.md) and [Code of Conduct](https://github.com/kafbat/kafka-ui/blob/main/.github/CODE-OF-CONDUCT.md)
3030

3131
**A picture of a cute animal (not mandatory but encouraged)**

README.md

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,46 @@
1-
![logo](documentation/images/logo.png) Kafbat UI 
2-
------------------
3-
#### Versatile, fast and lightweight web UI for managing Apache Kafka® clusters. Built by developers, for developers.
4-
<br/>
1+
<div align="center">
2+
<img src="documentation/images/logo_new.png" alt="logo"/>
3+
<h3>Kafbat UI</h3>
54

6-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/kafbat/kafka-ui/blob/main/LICENSE)
7-
![Price free](documentation/images/free-open-source.svg)
8-
[![Release version](https://img.shields.io/github/v/release/kafbat/kafka-ui)](https://github.com/kafbat/kafka-ui/releases)
9-
[![Chat with us](https://img.shields.io/discord/897805035122077716)](https://discord.gg/4DWzD7pGE5)
10-
[![Docker pulls](https://img.shields.io/docker/pulls/kafbat/kafka-ui)](https://hub.docker.com/r/kafbat/kafka-ui)
5+
Versatile, fast and lightweight web UI for managing Apache Kafka® clusters.
6+
</div>
7+
8+
<div align="center">
9+
<a href="https://github.com/kafbat/kafka-ui/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License"/></a>
10+
<img src="documentation/images/free-open-source.svg" alt="price free"/>
11+
<a href="https://github.com/kafbat/kafka-ui/releases"><img src="https://img.shields.io/github/v/release/kafbat/kafka-ui" alt="latest release version"/></a>
12+
<a href="https://discord.gg/4DWzD7pGE5"><img src="https://img.shields.io/discord/897805035122077716" alt="discord online number count"/></a>
13+
<a href="https://github.com/sponsors/kafbat"><img src="https://img.shields.io/github/sponsors/kafbat?style=flat&logo=githubsponsors&logoColor=%23EA4AAA&label=Support%20us" alt="" /></a>
14+
</div>
1115

1216
<p align="center">
13-
<a href="https://ui.docs.kafbat.io/">DOCS</a> •
14-
<a href="https://ui.docs.kafbat.io/configuration/quick-start">QUICK START</a> •
15-
<a href="https://discord.gg/4DWzD7pGE5">COMMUNITY DISCORD</a>
17+
<a href="https://ui.docs.kafbat.io/">Documentation</a> •
18+
<a href="https://ui.docs.kafbat.io/configuration/quick-start">Quick Start</a> •
19+
<a href="https://discord.gg/4DWzD7pGE5">Community</a>
1620
<br/>
1721
<a href="https://aws.amazon.com/marketplace/pp/{replaceMe}">AWS Marketplace</a> •
1822
<a href="https://www.producthunt.com/products/ui-for-apache-kafka/reviews/new">ProductHunt</a>
1923
</p>
2024

2125
<p align="center">
22-
<img src="https://repobeats.axiom.co/api/embed/2e8a7c2d711af9daddd34f9791143e7554c35d0f.svg" />
26+
<img src="https://repobeats.axiom.co/api/embed/88d2bd9887380c7d86e2f986725d9af52ebad7f4.svg" alt="stats"/>
2327
</p>
2428

2529
#### Kafbat UI is a free, open-source web UI to monitor and manage Apache Kafka clusters.
2630

2731
Kafbat UI is a simple tool that makes your data flows observable, helps find and troubleshoot issues faster and deliver optimal performance. Its lightweight dashboard makes it easy to track key metrics of your Kafka clusters - Brokers, Topics, Partitions, Production, and Consumption.
2832

29-
![Interface](documentation/images/Interface.gif)
33+
<i>
34+
Kafbat UI, developed by <b>Kafbat</b>*, proudly carries forward the legacy of the UI Apache Kafka project.
35+
Our dedication is reflected in the continuous evolution of the project, ensuring adherence to its foundational vision while adapting to meet modern demands.
36+
We extend our gratitude to Provectus for their past support in groundbreaking work, which serves as a cornerstone for our ongoing innovation and dedication.
37+
38+
<b>*</b> - The <b>Kafbat</b> team comprises key contributors from the project's inception, bringing a wealth of experience and insight to this renewed endeavor.
39+
</i>
40+
41+
# Interface
42+
43+
![Interface](https://raw.githubusercontent.com/kafbat/kafka-ui/images/overview.gif)
3044

3145
# Features
3246
* **Multi-Cluster Management** — monitor and manage all your clusters in one place
@@ -108,7 +122,7 @@ services:
108122
- ~/kui/config.yml:/etc/kafkaui/dynamic_config.yaml
109123
```
110124

111-
Please refer to our [configuration](https://ui.docs.kafbat.io/configuration/quick-start) page to proceed with further app configuration.
125+
Please refer to our [configuration](https://ui.docs.kafbat.io/configuration/configuration-file) page to proceed with further app configuration.
112126

113127
## Some useful configuration related links
114128

@@ -134,8 +148,13 @@ Info endpoint (build info) is located at `/actuator/info`.
134148

135149
# Configuration options
136150

137-
All of the environment variables/config properties could be found [here](https://ui.docs.kafbat.io/configuration/misc-configuration-properties).
151+
All the environment variables/config properties could be found [here](https://ui.docs.kafbat.io/configuration/misc-configuration-properties).
138152

139153
# Contributing
140154

141155
Please refer to [contributing guide](https://ui.docs.kafbat.io/development/contributing), we'll guide you from there.
156+
157+
# Support
158+
159+
As we're fully independent, team members contribute in their free time.
160+
Your support is crucial for us, if you wish to sponsor us, take a look [here](https://github.com/sponsors/kafbat)

documentation/images/Interface.gif

-3.31 MB
Binary file not shown.

documentation/images/logo_new.png

5.83 KB
Loading

0 commit comments

Comments
 (0)