Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
brandon-barker committed Aug 21, 2014
1 parent 04a3555 commit 4dacb73
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: ```<table float-thead="floatTheadOptions">```

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.

0 comments on commit 4dacb73

Please sign in to comment.