Give some details about what this binding is meant for - a protocol, system, specific device.
If possible, provide some resources like pictures, a YouTube video, etc. to give an impression of what can be done with this binding. You can place such resources into a doc folder next to this README.md.
Please describe the different supported things / devices within this section.
Which different types are supported, which models were tested etc.?
Note that it is planned to generate some part of this based on the XML files within ESH-INF/thing of your binding.
Describe the available auto-discovery features here. Mention for what it works and what needs to be kept in mind when using it.
If your binding requires or supports general configuration settings, please create a folder cfg and place the configuration file <bindingId>.cfg inside it. In this section, you should link to this file and provide some information about the options. The file could e.g. look like:
# Configuration for the Philips Hue Binding
#
# Default secret key for the pairing of the Philips Hue Bridge.
# It has to be between 10-40 (alphanumeric) characters
# This may be changed by the user for security reasons.
secret=EclipseSmartHome
Note that it is planned to generate some part of this based on the information that is available within ESH-INF/binding of your binding.
If your binding does not offer any generic configurations, you can remove this section completely.
Describe what is needed to manually configure a thing, either through the (Paper) UI or via a thing-file. This should be mainly about its mandatory and optional configuration parameters. A short example entry for a thing file can help!
Note that it is planned to generate some part of this based on the XML files within ESH-INF/thing of your binding.
Here you should provide information about available channel types, what their meaning is and how they can be used.
Note that it is planned to generate some part of this based on the XML files within ESH-INF/thing of your binding.
Provide a full usage example based on textual configuration files (*.things, *.items, *.sitemap).
Feel free to add additional sections for whatever you think should also be mentioned about your binding!