add readme generation to the js websocket client

[derberg]

at the moment template https://github.com/asyncapi/generator/tree/master/packages/templates/clients/js/websocket/template only generates client.js. But the person that uses generator should also get a README.md file with explanation on how to use the generated client.

this README.md of course need to be properly templated. It will have few things static, but in the readme you want to generate a list of API, available functions that client gives you - this is dynamic info, one AsyncAPI doc can have 2 another 3 operations.

here is a hardcoded example of how somebody would use the client, in this case for Postman Websocket Echo: https://github.com/asyncapi/generator/blob/master/packages/templates/clients/js/websocket/example.js. This example pretty much shows what info you need as dev, if you want to use generated client.

In repo there is also AsyncAPI document for Hoppscotch public Websocket API. Try to generate client for it, and try to use it without looking into example.js

[sharvarii1]

Hey @derberg!
I’m interested in working on this issue. I’m a newbie, but I’d love to contribute! From what I understand, to solve this issue, we need to create a README.md.njk file that includes both static and dynamically generated content.
To get the dynamic information, we need to iterate over the channels and their operations in the AsyncAPI document to extract details about the available API methods. This will ensure that the generated README provides clear usage instructions for the client.
Does this approach sound correct? Any guidance would be appreciated!