From 4dacb73382da38615e9e408f5fdf1fb1e8e89c2a Mon Sep 17 00:00:00 2001 From: Brandon Barker Date: Thu, 21 Aug 2014 16:25:21 +0200 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 7fcee3e..15ba7ab 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,23 @@ angular-floatThead ============= **angular-floatThead** is a very simple wrapper around the awesome floatThead library by [@mkoryak](https://github.com/mkoryak/floatThead/) + + +## Installation + +#### via bower: +``` +$ bower install angular-float-thead +``` + +## Usage + +1. Include angular-float-thead as a dependency for your app + + ```js + angular.module('myApp', ['angular-floatThead']) + ``` + +2. Specify ```float-thead``` on your table element and optionally pass through a floatThead object as a parameter, eg: `````` + +3. If you want the directive to reinitialize when your tables data changes then specify an ```ng-model``` on your table and it will watch the collection/object and call 'reflow' when the data changes.