Skip to content
Newer
Older
100644 66 lines (46 sloc) 2.53 KB
d5ec656 @jsor Inital import of rewrite for 0.3
jsor authored
1 jCarousel - Riding carousels with jQuery
2 ========================================
3
c601540 @jsor Cleanup readme and point to new docs
jsor authored
4 jCarousel is a jQuery plugin for controlling a list of items in horizontal or
5 vertical order. It provides you with a full-featured and flexible toolset for
6 navigating any HTML based content in a carousel-like fashion.
d5ec656 @jsor Inital import of rewrite for 0.3
jsor authored
7
c601540 @jsor Cleanup readme and point to new docs
jsor authored
8 **Note**: The master branch contains the new version 0.3 which is not released
9 yet and is not compatible with [0.2](https://github.com/jsor/jcarousel/tree/0.2).
2230592 @jsor Add note about versions (#99)
jsor authored
10
c601540 @jsor Cleanup readme and point to new docs
jsor authored
11 Documentation
d5ec656 @jsor Inital import of rewrite for 0.3
jsor authored
12 -------------
13
0cb2b62 @jsor Add dist directory and related tasks to grunt.js
jsor authored
14 ### Reference
15
c601540 @jsor Cleanup readme and point to new docs
jsor authored
16 You can read the documentation of the version 0.3.0 [here](http://sorgalla.com/jcarousel/docs/):
b3fdf1a @jsor Extend readme
jsor authored
17
c601540 @jsor Cleanup readme and point to new docs
jsor authored
18 * [Installation](http://sorgalla.com/jcarousel/docs/reference/installation.html)
19 * [Configuration](http://sorgalla.com/jcarousel/docs/reference/configuration.html)
20 * [API](http://sorgalla.com/jcarousel/docs/reference/api.html)
21 * [Usage](http://sorgalla.com/jcarousel/docs/reference/usage.html)
22 * [Events](http://sorgalla.com/jcarousel/docs/reference/events.html)
b3fdf1a @jsor Extend readme
jsor authored
23
0cb2b62 @jsor Add dist directory and related tasks to grunt.js
jsor authored
24 ### Plugins
19714cb @jsor Add note about binding events
jsor authored
25
c601540 @jsor Cleanup readme and point to new docs
jsor authored
26 By default, the jCarousel core only contains the minimum functionality needed
27 to built carousel widgets. Specialized features are provided through plugins.
28 This prevents a bloated core and lets you pick only the features you really need.
61e1bc6 @jsor Add indention and linebreaks
jsor authored
29
c601540 @jsor Cleanup readme and point to new docs
jsor authored
30 jCarousel comes with the following plugins:
61e1bc6 @jsor Add indention and linebreaks
jsor authored
31
c601540 @jsor Cleanup readme and point to new docs
jsor authored
32 * [Control Plugin](http://sorgalla.com/jcarousel/docs/plugins/control/)
33 * [Pagination Plugin](http://sorgalla.com/jcarousel/docs/plugins/pagination/)
34 * [Autoscroll Plugin](http://sorgalla.com/jcarousel/docs/plugins/autoscroll/)
19714cb @jsor Add note about binding events
jsor authored
35
0cb2b62 @jsor Add dist directory and related tasks to grunt.js
jsor authored
36 Download
37 --------
38
39 All ready-to-use files are located in the
40 [`dist/`](https://github.com/jsor/jcarousel/tree/master/dist) directory.
41
42 The [`jquery.jcarousel-all.js`](https://raw.github.com/jsor/jcarousel/master/dist/jquery.jcarousel-all.js)
43 and [`jquery.jcarousel-all.min.js`](https://raw.github.com/jsor/jcarousel/master/dist/jquery.jcarousel-all.min.js)
44 files contain the core and all plugins concenated together.
45
c601540 @jsor Cleanup readme and point to new docs
jsor authored
46 Examples
47 --------
cdcab6c @jsor Add root element/instance specific events and selectors
jsor authored
48
c601540 @jsor Cleanup readme and point to new docs
jsor authored
49 There are no examples ready yet for the new version 0.3, but you can browse the
50 [functional tests](https://github.com/jsor/jcarousel/tree/master/test/functional)
0cb2b62 @jsor Add dist directory and related tasks to grunt.js
jsor authored
51 to get an impression how to setup things.
d5ec656 @jsor Inital import of rewrite for 0.3
jsor authored
52
53 Credits
54 -------
55
c601540 @jsor Cleanup readme and point to new docs
jsor authored
56 jCarousel is written on top of [jQuery](http://jquery.com) and was originally
57 inspired by the [Carousel Component](http://billwscott.com/carousel/) by
58 [Bill Scott](http://looksgoodworkswell.com).
c725b48 @jsor Infrastructure updates
jsor authored
59
60 License
61 -------
62
69d4779 @jsor Small tweak
jsor authored
63 Copyright (c) 2012 Jan Sorgalla.
c601540 @jsor Cleanup readme and point to new docs
jsor authored
64 Licensed under the [MIT](https://github.com/jsor/jcarousel/blob/master/LICENSE-MIT),
65 [GPL](https://github.com/jsor/jcarousel/blob/master/LICENSE-GPL) licenses.
Something went wrong with that request. Please try again.