diff --git a/README.md b/README.md index 85ac3bf..2674bae 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ ## Angular Advanced Searchbox [![Build Status](https://travis-ci.org/dnauck/angular-advanced-searchbox.png?branch=master)](https://travis-ci.org/dnauck/angular-advanced-searchbox) -A directive for AngularJS providing a advanced visual search box. +A directive for AngularJS providing an advanced visual search box. ### [DEMO](http://dnauck.github.io/angular-advanced-searchbox/) ### Usage -Include with bower +Include with Bower ```sh bower install angular-advanced-searchbox @@ -22,7 +22,7 @@ The bower package contains files in the ```dist/```directory with the following Files with the ```min``` suffix are minified versions to be used in production. The files with ```-tpls``` in their name have the directive template bundled. If you don't need the default template use the ```angular-paginate-anything.min.js``` file and provide your own template with the ```templateUrl``` attribute. -Load the javascript and css and declare your Angular dependency +Load the JavaScript and CSS, and declare your Angular dependency ```html @@ -112,7 +112,7 @@ param can be a scope variable as well as a hard-coded string. searchThrottleTime - Specifies the time in milliseconds to wait for changes in the ui until the ng-model is updated. Default is 1000ms. + Specifies the time in milliseconds to wait for changes in the UI until the ng-model is updated. Default is 1000ms. @@ -161,27 +161,27 @@ $scope.$on('advanced-searchbox:modelUpdated', function (event, model) { key - Unique key of the search parameter that is used for the ng-model value. + A unique key of the search parameter that is used for the ng-model value. string name - User friendly display name of the search parameter. + A user friendly display name of the search parameter. string placeholder - Specifies a short hint in the parameter search box + Specifies a short hint in the parameter search box. string allowMultiple - Should multiple search parameters of the same key allowed? Output type changes to array of values. Default is false. + Should multiple search parameters of the same key allowed? Output type changes to an array of values. Default is false. boolean suggestedValues - An array of suggested search values, e.g. ['Berlin', 'London', 'Paris'] + An array of suggested search values, e.g. ['Berlin', 'London', 'Paris']. string[] @@ -200,4 +200,4 @@ $scope.availableSearchParams = [ { key: "city", name: "City", placeholder: "City...", restrictToSuggestedValues: true, suggestedValues: ['Berlin', 'London', 'Paris'] } { key: "email", name: "E-Mail", placeholder: "E-Mail...", allowMultiple: true }, ]; -``` \ No newline at end of file +```