diff --git a/README.md b/README.md index 2639275..e19de1e 100644 --- a/README.md +++ b/README.md @@ -35,4 +35,35 @@ npm i gulp bower -g npm install bower install gulp watch -``` \ No newline at end of file +``` + + +## Getting started + +### Basic setup + +1. Make sure you have materialize css (including their JavaScript files): http://materializecss.com/ + +2. Install this package via npm or bower. Alternatively you can also download the [source](https://github.com/chingyawhao/materialize-clockpicker/tree/master/src) files and add them to your project manually. + +3. Create an input field in your html code like the following: + + ``` +
+ + +
+ ``` + +4. Add the Javascript trigger with the corresponding [options](https://github.com/chingyawhao/materialize-clockpicker#options) + + ``` + + ``` + +You can trigger the clock either by ID's or classes (useful if you have several clocks on one page).