diff --git a/README.md b/README.md index d479920..e196f4a 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,172 @@ -# Ember-cli-bootstrap3-carousel +# ember-cli-bootstrap3-carousel [![GitHub version](http://badge.fury.io/gh/cybertoothca%2Fember-cli-bootstrap3-carousel.svg)](http://badge.fury.io/gh/cybertoothca%2Fember-cli-bootstrap3-carousel) ![](http://embadge.io/v1/badge.svg?start=2.3.0) -This README outlines the details of collaborating on this Ember addon. +[![npm version](http://badge.fury.io/js/ember-cli-bootstrap3-carousel.svg)](http://badge.fury.io/js/ember-cli-bootstrap3-carousel) [![CircleCI](http://circleci.com/gh/cybertoothca/ember-cli-bootstrap3-carousel.svg?style=shield)](http://circleci.com/gh/cybertoothca/ember-cli-bootstrap3-carousel) [![Code Climate](http://codeclimate.com/github/cybertoothca/ember-cli-bootstrap3-carousel/badges/gpa.svg)](http://codeclimate.com/github/cybertoothca/ember-cli-bootstrap3-carousel) ![Dependencies](http://david-dm.org/cybertoothca/ember-cli-bootstrap3-carousel.svg) [![ember-observer-badge](http://emberobserver.com/badges/ember-cli-bootstrap3-carousel.svg)](http://emberobserver.com/addons/ember-cli-bootstrap3-carousel) [![License](http://img.shields.io/npm/l/ember-cli-bootstrap3-carousel.svg)](LICENSE.md) + +This addon can create a basic Bootstrap3 carousel that can lazy-load images. See the +[Bootstrap3 Carousel](http://getbootstrap.com/javascript/#carousel) documentation for additional information. + +## Demo + +The demonstration web application can be found here: +[http://ember-cli-bootstrap3-carousel.cybertooth.io/](http://ember-cli-bootstrap3-carousel.cybertooth.io/). + +## What Does This Addon Do? + +This addon supplies the following _components_: + +* `twbs-carousel` - a container-like element for the carousel's slides. +* `twbs-carousel/slide` - a component representing a slide that is nested +inside a `twbs-carousel`. +* `twbs-carousel/slide/img` - a component generating an html `` tag +that has the ability to be lazily loaded by the carousel's slide event. + +The following _mixin_ also ships with this addon: + +* `Carousel` - imported as `import Carousel as 'ember-cli-bootstrap3-carousel/mixins/carousel'` and includes all +of the carousel options as found in the [Bootstrap documentation](http://getbootstrap.com/javascript/#carousel-options). + +_Further information about these items can be found in the Usage section below._ + +## Requirements + +* **Ember >= 2.3.0**: This addon uses the [hash helper](http://emberjs.com/blog/2016/01/15/ember-2-3-released.html#toc_hash-helper) which was introduced in Ember-2.3.0. +* Ember CLI +* You must have Bootstrap 3.x installed in your Ember application. Feel free to use the + [ember-cli-bootstrap3-sass](http://emberobserver.com/addons/ember-cli-bootstrap3-sass) + addon to setup Bootstrap if you haven't already done so. ## Installation -* `git clone ` this repository -* `cd ember-cli-bootstrap3-carousel` +The following will install this addon: + + $ ember install ember-cli-bootstrap3-carousel + +__As mentioned, you must install Bootstrap3 along with the tooltip plugin. See the requirements section above.__ + +### Upgrading + +When working through the Ember upgrade process, I recommend +invoking the `ember install ember-cli-bootstrap3-carousel` command once +you are done to get the latest version of the addon. + +## Usage + +As mentioned above there are several examples on the demonstration site: +[http://ember-cli-bootstrap3-carousel.cybertooth.io/](http://ember-cli-bootstrap3-carousel.cybertooth.io/) + +### Components + +#### `{{twbs-carousel}}` + +A component that creates the `