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

README enhancements #55

Open
zenflow opened this issue Jul 27, 2022 · 0 comments
Open

README enhancements #55

zenflow opened this issue Jul 27, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@zenflow
Copy link
Owner

zenflow commented Jul 27, 2022

  • general editing
  • less verbose Features section
  • simplify/reduce Basic Usage section
  • explain ServiceConfig.ready function before Crash Handling (which should be changed to Custom Crash Handling)
  • Shutting down: detail "optional behaviors"
  • Shutting Down: "hint" -> Caveats (need for windowsCtrlCShutdown /w e.g. nodemon)

and enhancements to README for https://github.com/zenflow/composite-service-http-gateway
@zenflow zenflow added the documentation Improvements or additions to documentation label Jul 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@zenflow