search

axone-protocol / axone-contract-schema

🚀 Client libraries (for different languages) simplifying Axone chain interactions.
BSD 3-Clause "New" or "Revised" License
5 stars 1 forks source link

📄 Docs: automatically generate README.md for typescript #11

Closed bdeneux closed 1 year ago

bdeneux commented 1 year ago

📄 Description

Add documentation on each typescripts package by generating each one based on the schema documentation.

🚀 Publication

Each time a commit is done on contract repository, schema and README documentation is updated on this repository through a README.md.template located at the ts/ root path folder by using gomplate to complete fields in template.

It's avoiding rewrite for each package the installation guide and add type documentation on README.md.