Summary
It's important for clients to jump-start and be able to use this library. Therefore it's essential we have good documentation.
This documentation comes from:
npm run doc "Generate HTML API documentation and open it in a browser"
npm run doc:json "Generate API documentation in typedoc JSON format"
README.md should also cover examples and a complete documentation.
okanaganrusty
commented
4 years ago
Summary It's important for clients to jump-start and be able to use this library. Therefore it's essential we have good documentation. This documentation comes from: npm run doc "Generate HTML API documentation and open it in a browser" npm run doc:json "Generate API documentation in typedoc JSON format"
README.md should also cover examples and a complete documentation.