Skip to content

Commit b1dc213

Browse files
author
Karan Batra-Daitch
committed
Update README.md
1 parent 6381162 commit b1dc213

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,14 @@ Release: 2.0
99
was working but arbitrary. We now register a simple `onFinishRender` directive which
1010
allows us to postpone slickification until `ng-repeat` has finished execution.
1111
2. **[BC-BREAK]** The directive is no longer based on a transclude functionality. You can either use the 2.0
12-
directive with the provided template or use your own (with [slick-no-tpls.js](dist/slick-no-tpls.js)). The two functions `isImage` and `isVideo` on
13-
the directive's scope are provided for use in the template, and are overridable.
14-
3. **[BC-BREAK]** The directive no longer supports statically provided image assets out-of-the-box.
12+
directive with the provided template or use your own (with [slick-no-tpls.js](dist/slick-no-tpls.js)). When using
13+
the latter option, refer to [slick.coffee](https://github.com/kbdaitch/angular-slick-carousel/blob/master/src/slick.coffee#L12-L18) and ensure your template uses `on-finish-render=init()` in its `ng-repeat` element.
14+
3. The two functions `isImage` and `isVideo` on the directive's scope are provided for use in the template,
15+
and are overridable.
16+
4. **[BC-BREAK]** The directive no longer supports statically provided image assets out-of-the-box.
1517
The dynamic usecase is what it tries to solve optimally.
16-
4. You can now use JS to specify a variety of sources in the `media` array. See [example](https://github.com/kbdaitch/angular-slick-carousel/blob/master/example/index.html).
17-
5. There is an additional `on-directive-init` attribute available now. Use this to use the handle object to do something on
18-
directive init. This is different from the underlying `slick.js` `onInit` in that the handle object is now ready to use
18+
5. You should now use JS to specify a variety of sources in the `media` array. See [example](https://github.com/kbdaitch/angular-slick-carousel/blob/master/example/index.html).
19+
6. The use of `on-directive-init` attribute introduced earlier is now in the demo. Use this to use the handle object to do something on directive init. This is different from the underlying `slick.js` `onInit` in that the handle object is now ready to use
1920
(with all the setup to call underlying `slick.js` calls).
2021

2122
Usage
@@ -82,7 +83,7 @@ Demo
8283
----
8384

8485
1. Look at the [example](https://github.com/kbdaitch/angular-slick-carousel/tree/master/example) in this repo for full usage.
85-
2. Running examples: [ng-repeated by the directive](http://bardo.io/angular-slick-carousel/app/index.html).
86+
2. Running [example](http://bardo.io/angular-slick-carousel/app/index.html).
8687
3. Or, clone the repo and run a simple HTTP server in the example directory.
8788

8889
[![Support via Gittip](https://rawgithub.com/twolfson/gittip-badge/0.2.0/dist/gittip.png)](https://www.gittip.com/kbdaitch/)

0 commit comments

Comments
 (0)