diff --git a/README.md b/README.md index 4f0c3bc..ffd3a4e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,16 @@ -# CG-SELECT ------------------------------------------------------ -This component allows you to create a generic select. ------------------------------------------------------ -All documentation on the select is located in the folder of the same name + +# CG-SELECT +This component allows you to create a generic custom select. Customization, multiselect, search by select elements are available. +## Installation +TODO: Describe the installation process +## Usage +All documentation on the select is located in the folder of the same name. The documentation describes all the methods and variables, there are also examples of passing settings to the select. To view it, run the index.html file from the documentation folder. +## Contributing +1. Fork it! +2. Create your feature branch: `git checkout -b my-new-feature` +3. Commit your changes: `git commit -am 'Add some feature'` +4. Push to the branch: `git push origin my-new-feature` +5. Submit a pull request :D +## History +TODO: Write history