Skip to content
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.

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

docs: update project readme and template readme with updated instructions #269

Merged
merged 11 commits into from
Apr 29, 2024

Conversation

kaushik-rishi
Copy link
Collaborator

Related issue(s)
#133

Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

you still need to update "ag" commands to follow new "asyncapi generate fromTemplate" using AsyncAPI CLI

also now I see why you wanted to generate instead of hardcore - we misunderstood each other. I meant you need to put a custom hardcode script in "test", maybe"test/example" and update main package.json and main readme within structuon how to use it.

for readme in template, just put generic instructions on what is generated. explain that user you need to create code where generated client can be imported, explain how to start server and explain where generated API is located, so user can manually check

Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@derberg
Copy link
Member

derberg commented Apr 29, 2024

/rtm

@asyncapi-bot asyncapi-bot merged commit 6a0ff0b into asyncapi:master Apr 29, 2024
10 checks passed
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 3.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants