Open
Description
The README should be more helpful and welcoming. Right now it sucks and I hate projects with sucky READMEs
- Provide better usage documentation for people just using it as-is.
- Provide expanded section for additional middleware authors.
- Provide documentation for providing full middleware stacks
- Provide documentation for providing partial middleware stacks
- Table of contents
- Installation details
- Basic usage example
- Add API documentation for existing middleware types
- Get philosophical with it. Short explanation of why compose is awesome and what benefit this gives you over how most people deal with middleware. Maybe a longer explanation towards the bottom
- Ensure README for each package is descriptive for NPM
- Ensure main README demonstrates compositions across full project
- Fix README to be correct name in each repo
- Fix badges and links to point to correct NPM and builds
Metadata
Assignees
Labels
No labels