Repository navigation
docs: add Quick Start section to README - #1895
Open
SyncCore04 wants to merge 1 commit into
Open
SyncCore04 wants to merge 1 commit into
SyncCore04 wants to merge 1 commit into
Conversation
✅ Deploy Preview for springwolf-ui canceled.
|
There was a problem hiding this comment.
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
${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)@KafkaListenerexample, emphasizing that no extra code is required/springwolf/docs) and the UI endpoint (/springwolf/asyncapi-ui.html)application.propertiesconfiguration detailsNotes