Skip to content

docs: add Quick Start section to README - #1895

Open
SyncCore04 wants to merge 1 commit into
springwolf:mainfrom
SyncCore04:docs/add-quick-start
Open

SyncCore04 wants to merge 1 commit into
springwolf:mainfrom
SyncCore04:docs/add-quick-start

Conversation

@SyncCore04

Copy link
Copy Markdown

Summary

Added a concise Quick Start section to the README, placed between "Demo & Documentation" and "Why You Should Use Springwolf". This gives new users a minimal, copy-paste-ready path to see Springwolf in action without leaving the README.

Changes

  • Added "Quick Start" entry to the table of contents
  • New section includes three steps:
    1. Add the Maven dependency — uses ${springwolf.version} placeholder with a comment pointing to the version badge in the Kafka plugin row below (avoids hard-coding a version that would go stale)
    2. Annotate existing listeners — shows a minimal @KafkaListener example, emphasizing that no extra code is required
    3. Start and view docs — lists the AsyncAPI JSON endpoint (/springwolf/docs) and the UI endpoint (/springwolf/asyncapi-ui.html)
  • Ends with a link to the full quickstart guide on springwolf.dev for application.properties configuration details

Notes

  • The section intentionally stays minimal — it complements (not replaces) the full documentation on springwolf.dev
  • No existing content was modified or removed
  • Version is not hard-coded, consistent with the rest of the README which uses dynamic badges

@netlify

netlify Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for springwolf-ui canceled.

Name Link
🔨 Latest commit 6ddd8d3
🔍 Latest deploy log https://app.netlify.com/projects/springwolf-ui/deploys/6abd444e0e80cb0008113f0a

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to Springwolf. Thanks a lot for creating your first pull request. Please check out our contributors guide and feel free to join us on discord.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant