It would be very useful for maintainability, consistency, and accuracy to automatically generate part of README.md.
It could include the following generated information:
Required Cicero engine version
Name and Description (from package.json)
Request/response type model and samples
Emit type model and samples
Sample.txt
This should be combined with any text written by the user in README.md, perhaps using a template syntax. E.g.
{name}
{description}
Requires Cicero: {ciceroVersion}
This is my really great clause template that rules the world.
Samples
{samples}
Request Types
{requestTypes}
Reponse Types
{responseTypes}
Emitted Types
{emittedTypes}
It would be very useful for maintainability, consistency, and accuracy to automatically generate part of README.md.
It could include the following generated information:
This should be combined with any text written by the user in README.md, perhaps using a template syntax. E.g.