Create README for this template
fmvilas opened this issue · 14 comments
Make sure we don't forget to include:
- How to install it.
- How to use it.
- The params it supports.
- The requirement of
operationIdon each operation (otherwise, the code would not work). - This README should serve as a template for the rest of the generator templates.
Welcome to AsyncAPI. Thanks a lot for reporting your first issue.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
would be awesome to have a template of the readme for all repos for consistency reasons, especially template readmies
Good point. Added it to the description.
This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️
This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️
This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️
video on how to approach this issue https://youtu.be/Iqs_2BiNEEo?t=1265
last part of requirement, turning this readmy into a readme template, is covered by asyncapi/template-for-generator-templates#1
This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️
This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️
I want to work on this. please assign it to me. I think there is a lot of things that I can learn by doing this.
@KhudaDad414 assigned. I think the best is to have a look at this PR where I added a readme for another nodejs template -> https://github.com/asyncapi/nodejs-ws-template/pull/53/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5
Let me know if you need something more
@derberg thanks. I'll start working on this.
🎉 This issue has been resolved in version 0.10.0 🎉
The release is available on:
Your semantic-release bot 📦🚀