robertmeisner/watering-machine

Improve README.md

Closed this issue · 1 comments

robertmeisner commented

Documentation should include:

  • Introduction
  • Installation guide
  • Improvements and changes
  • Questions
    For questions about the usage of the libraries, please post a question on???
  • Bugs and issues
    For bugs in the libraries, please fill in an issue in Github as that makes it far easier to track them. If possible provide a minimal code snippet that exposes the bug. Also proposals for solutions are welcome.
    Issues are not bugs but still possible problematic. E.g. if a library is too slow for your application that is an issue, not a bug. Please fill in an issue and provide as much details about your requirements.
  • License and Warranty
    I appreciate if you give credits when appropriate, and if you want to donate, please donate to charity like "doctors without borders".
    Please check the file LICENSE and NOTICE for the details.
robertmeisner commented

Should add example BoM for esp8266