From 067aa392ced7248fa69da78dc108d1d255a6ea25 Mon Sep 17 00:00:00 2001 From: Josh Johnson Date: Tue, 21 Jun 2016 23:12:10 +0100 Subject: [PATCH] Update readme --- README.md | 43 ++++++++++++++++++++++++++++--------------- 1 file changed, 28 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index e3df513..650a2c9 100644 --- a/README.md +++ b/README.md @@ -198,43 +198,55 @@ classNames: { ## Methods -#### `highlightAll();` +#### highlightAll(); Usage: Highlight each chosen item (selected items can be removed). -#### `unhighlightAll();` + +#### unhighlightAll(); Usage: Un-highlight each chosen item. -#### `removeItemsByValue(value);` + +#### removeItemsByValue(value); Usage: Remove each item by a given value. -#### `removeActiveItems(excludedId);` + +#### removeActiveItems(excludedId); Usage: Remove each selectable item. -#### `removeSelectedItems();` + +#### removeSelectedItems(); Usage: Remove each item the user has selected. -#### `showDropdown();` -Usage: Show option list dropdown -#### `hideDropdown();` -Usage: Hide option list dropdown +#### showDropdown(); +Usage: Show option list dropdown. -#### `toggleDropdown();` + +#### hideDropdown(); +Usage: Hide option list dropdown. + + +#### toggleDropdown(); Usage: Toggle dropdown between showing/hidden. -#### `setValue(args);` + +#### setValue(args); Usage: Set value of input based on an array of objects or strings. -#### `clearValue();` + +#### clearValue(); Usage: Clear value of input. -#### `clearInput();` + +#### clearInput(); Usage: Clear input. -#### `disable();` + +#### disable(); Usage: Disable input from selecting further options. -#### `ajax(fn);` + +#### ajax(fn); Usage: Populate options via a callback. @@ -250,6 +262,7 @@ To setup a local environment: clone this repo, navigate into it's directory in a * ```npm start``` * ```npm run js:build``` * ```npm run css:watch``` +* ```npm run css:build``` ## Contributions In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using npm scripts...bla bla bla