Merge branch 'master' of github.com:mendix/SimpleCheckboxSetSelector

Author: RoelandSalij

README.md

@@ -1,2 +1,20 @@
 # SimpleCheckboxSetSelector
-Input widget to render a reference set as a checkbox list
+Checkbox based input widget for reference sets. Useful replacement for the default reference set selector widget.
+
+## Description
+This widget enables you to render your reference set association as a checkbox list.
+
+## Contributing
+For more information on contributing to this repository visit [Contributing to a GitHub repository] (https://world.mendix.com/display/howto50/Contributing+to+a+GitHub+repository)
+
+## Typical usage scenario
+Visualize all possible options in your user interface, instead of forcing your user to open a pop-up window to reference available options.
+
+## Features and limitations
+ 
+- Displaying the list in a horizontal or vertical direction.
+- Option to show a label(as is done for input widgets since Mx 5.18)
+- Attaching a microflow on the onchange event.
+
+## Installation
+Import the widget to your project and add it to a dataview on a page. Configure the properties to determine how the widget will behave in your application.