accordproject / template-archive

Smart Legal Contracts & Templating System
https://accordproject.org/projects/cicero/
Apache License 2.0
282 stars 119 forks source link

Automatically generate part of the README.md for Clause/Contract #96

Closed dselman closed 6 years ago

dselman commented 6 years ago

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.

{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}
dselman commented 6 years ago

This is now implemented on https://templates.accordproject.org