Skip to content

Enhance README for new user clarity #3099

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dipgarg0011 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Enhance README for new user clarity #3099

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# A Diskless Kafka® on S3, Offering 10x Cost Savings and Scaling in Seconds.
> 💡 *Note: This small update improves readability for new users trying AutoMQ for the first time.*


<div align="center">
<p align="center">
Expand Down Expand Up @@ -86,6 +88,8 @@
- [AutoMQ Helps CaoCao Mobility Address Kafka Scalability During Holidays](https://www.automq.com/blog/automq-helps-caocao-mobility-address-kafka-scalability-issues-during-mid-autumn-and-national-day?utm_source=github_automq)

## ⛄ Get started with AutoMQ
If you're new to AutoMQ, start with the single-node Docker setup. It is the easiest way to understand how AutoMQ works before exploring cluster mode.


> [!Tip]
> Deploying a production-ready AutoMQ cluster is challenging. This Quick Start is only for evaluating AutoMQ features and is not suitable for production use. For production deployment best practices, please [contact](https://www.automq.com/contact) our community for support.
Expand Down
Loading