search

streamingfast / substreams

Powerful Blockchain streaming data engine, based on StreamingFast Firehose technology.
Apache License 2.0
159 stars 45 forks source link

Pick up docs from the README.md instead of the top-level `package.doc` yaml definition. #425

Closed abourget closed 6 months ago

abourget commented 6 months ago

Like NPM does. Implement in the substreams pack command. Read the README.md file, when the package.doc was not specified.

Print: Importing README.md file as package documentation. when that happens, before print "Wrote ... .spkg" or something.

Support README also (and ReAdMe.md).

Relative to the substreams.yaml file being packed.

Add a changelog entry to tell people about it. When it merges, we push that to the documentation.

abourget commented 6 months ago

https://github.com/streamingfast/substreams/pull/427