Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix README #4

Open
8 of 13 tasks
DavidJFelix opened this issue Jan 10, 2019 · 5 comments
Open
8 of 13 tasks

Fix README #4

DavidJFelix opened this issue Jan 10, 2019 · 5 comments
Assignees
@DavidJFelix
Milestone
v1

Comments

@DavidJFelix
Copy link
Member

DavidJFelix commented Jan 10, 2019 •
edited
Loading

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
@DavidJFelix
Copy link
Member Author

Created a simple as-is readme with some information on how to implement custom middleware handlers.

@with-heart
Copy link
Contributor

with-heart commented Jan 12, 2019 •
edited by DavidJFelix
Loading

  • Installation details
  • Basic usage example
  • 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

@DavidJFelix
Copy link
Member Author

Adding @lionize comments to base comment for better progress tracking

@DavidJFelix DavidJFelix mentioned this issue Jan 12, 2019
Closed
@DavidJFelix
Copy link
Member Author

DavidJFelix commented Mar 4, 2019 •
edited
Loading

  • Ensure README for each package is descriptive for NPM
  • Ensure main README demonstrates compositions across full project

@DavidJFelix
Copy link
Member Author

  • Fix README to be correct name in each repo
  • Fix badges and links to point to correct NPM and builds

@DavidJFelix DavidJFelix self-assigned this Nov 17, 2019
@DavidJFelix DavidJFelix added this to the v1 milestone Dec 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DavidJFelix DavidJFelix

Labels
None yet
Projects
None yet
Milestone
v1
Development

No branches or pull requests
2 participants
@DavidJFelix @with-heart