This change introduces a generated README.md which is built using README-template.md and scripts from bin/. At the moment the scripts only generate the API documentation and dumps it into the $API_DOC placeholder found in the template. The documentation is generated by using react-docgen to extract comments from the source code.
The README is generated by running npm run generate-readme. This can either be done in the PR which introduces a change, or just before publishing (as described in "Publishing / Releasing").
@sprjr: Mind giving it a once-over before I merge this?
This change introduces a generated
README.mdwhich is built usingREADME-template.mdand scripts frombin/. At the moment the scripts only generate the API documentation and dumps it into the$API_DOCplaceholder found in the template. The documentation is generated by usingreact-docgento extract comments from the source code.The README is generated by running
npm run generate-readme. This can either be done in the PR which introduces a change, or just before publishing (as described in "Publishing / Releasing").@sprjr: Mind giving it a once-over before I merge this?