|
1 | | -##Bootstrap-Iconpicker v1.0.1 |
| 1 | +# [Bootstrap-Iconpicker v1.4.0](http://victor-valencia.github.io/bootstrap-iconpicker) |
2 | 2 |  |
3 | 3 |
|
4 | | -A simple iconpicker. |
5 | | - |
6 | | -See live examples here: <a href="http://victor-valencia.github.io/bootstrap-iconpicker">http://victor-valencia.github.io/bootstrap-iconpicker</a> |
| 4 | +A simple iconpicker for Bootstrap 3. |
7 | 5 |
|
8 | 6 | Please note that this project is for <a href="http://getbootstrap.com/"><strong>Bootstrap 3.2</strong></a>, including Glyphicons or <a href="http://fontawesome.io/"><strong>Font Awesome Icons</strong></a> . |
9 | 7 |
|
10 | | -##1.- Configuration (Glyphicon): |
11 | | -1.1.- Add the style file bootstrap-iconpicker.min.css |
| 8 | +## Table of contents |
| 9 | +- [Quick start](#quick-start) |
| 10 | +- [Documentation and live examples](#documentation-and-live-examples) |
| 11 | +- [Changelog](#changelog) |
| 12 | +- [Versioning](#versioning) |
| 13 | +- [Author](#author) |
| 14 | +- [Contributors](#contributors) |
| 15 | +- [License](#license) |
12 | 16 |
|
13 | | -``` |
14 | | -<link rel="stylesheet" href="bootstrap-iconpicker/css/bootstrap-iconpicker.min.css"/> |
15 | | -``` |
| 17 | +## Quick start |
16 | 18 |
|
17 | | -1.2.- Add the javascript file bootstrap-iconpicker.min.js |
| 19 | +Three quick start options are available: |
18 | 20 |
|
19 | | -``` |
20 | | -<script type="text/javascript" src="bootstrap-iconpicker/js/bootstrap-iconpicker.min.js"></script> |
21 | | -``` |
| 21 | +- [Download the latest release](https://github.com/victor-valencia/bootstrap-iconpicker/archive/master.zip). |
| 22 | +- Clone the repo: `git clone https://github.com/victor-valencia/bootstrap-iconpicker.git`. |
| 23 | +- Install with [Bower](http://bower.io): `bower install bootstrap-iconpicker`. |
22 | 24 |
|
23 | | -##2.- Configuration (Font Awesome 4.2.0): |
24 | | -2.1.- Add the style file bootstrap-iconpicker.min.css and Font Awesome style file font-awesome.min.css |
| 25 | +### What's included |
| 26 | +Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this: |
25 | 27 |
|
26 | 28 | ``` |
27 | | -<link rel="stylesheet" href="bootstrap-iconpicker/css/bootstrap-iconpicker.min.css"/> |
28 | | -<link rel="stylesheet" href="font-awesome-4.2.0/css/font-awesome.min.css"/> |
| 29 | +bootstrap-iconpicker/ |
| 30 | +├── css/ |
| 31 | +│ ├── bootstrap-iconpicker.css |
| 32 | +│ ├── bootstrap-iconpicker.min.css |
| 33 | +├── js/ |
| 34 | +│ ├── font-awesome/ |
| 35 | +│ ├── fa-icon-names-4.0.0.js |
| 36 | +│ ├── fa-icon-names-4.0.0.min.js |
| 37 | +│ ├── fa-icon-names-4.1.0.js |
| 38 | +│ ├── fa-icon-names-4.1.0.min.js |
| 39 | +│ ├── fa-icon-names-4.2.0.js |
| 40 | +│ ├── fa-icon-names-4.2.0.min.js |
| 41 | +│ ├── bootstrap-iconpicker.js |
| 42 | +│ └── bootstrap-iconpicker.min.js |
29 | 43 | ``` |
30 | 44 |
|
31 | | -2.2.- Add the Font Awesome icon names file fa-icon-names-4.2.0.min.js and javascript file bootstrap-iconpicker.min.js |
| 45 | +We provide compiled CSS and JS (`bootstrap-iconpicker.*`), as well as compiled and minified CSS and JS (`bootstrap-iconpicker.min.*`). |
32 | 46 |
|
33 | | -``` |
34 | | -<script type="text/javascript" src="bootstrap-iconpicker/js/font-awesome/fa-icon-names-4.2.0.min.js"></script> |
35 | | -<script type="text/javascript" src="bootstrap-iconpicker/js/bootstrap-iconpicker.min.js"></script> |
36 | | -``` |
| 47 | +## Documentation and live examples |
| 48 | +See documentation and live examples here: <a href="http://victor-valencia.github.io/bootstrap-iconpicker">http://victor-valencia.github.io/bootstrap-iconpicker</a> |
| 49 | + |
| 50 | +## Changelog |
| 51 | +- v1.0.0 - Version initial. @[victor-valencia](https://github.com/victor-valencia) |
| 52 | +- v1.0.1 - Reducing the size of the source file. @[victor-valencia](https://github.com/victor-valencia) |
| 53 | +- v1.1.0 - Dispatch 'change' event when an iconpicker is changed. @[promatik](https://github.com/promatik) |
| 54 | +- v1.2.0 - Add the method 'setIcon'. @[victor-valencia](https://github.com/victor-valencia) |
| 55 | +- v1.2.1 - Add '.iconpicker-popover' class. @[jwhitfieldseed](https://github.com/jwhitfieldseed) |
| 56 | +- v1.3.0 - Support multiple versions of FontAwesome. @[victor-valencia](https://github.com/victor-valencia) |
| 57 | +- v1.3.1 - Bind body 'click' to solve issues for ajax loaded pages. @[crlcu](https://github.com/crlcu) |
| 58 | +- v1.4.0 - Support for customization of the component. @[victor-valencia](https://github.com/victor-valencia) |
37 | 59 |
|
38 | | -##Changelog |
39 | | -- v1.0.0 - Version initial. |
40 | | -- v1.0.1 - Is added to support multiple versions of FontAwesome |
| 60 | +## Versioning |
| 61 | +For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap is maintained under [the Semantic Versioning guidelines](http://semver.org/). Sometimes we screw up, but we'll adhere to those rules whenever possible. |
41 | 62 |
|
42 | | -##Author |
| 63 | +## Author |
43 | 64 | @[victor-valencia](https://github.com/victor-valencia) |
44 | 65 |
|
45 | | -##Contributors |
46 | | -@[victor-valencia](https://github.com/victor-valencia), @[promatik](https://github.com/promatik), @[jwhitfieldseed](https://github.com/jwhitfieldseed) |
| 66 | +## Contributors |
| 67 | +@[victor-valencia](https://github.com/victor-valencia), @[promatik](https://github.com/promatik), @[jwhitfieldseed](https://github.com/jwhitfieldseed), @[crlcu](https://github.com/crlcu) |
47 | 68 |
|
48 | | -##License |
49 | | -Licensed under The MIT License. |
| 69 | +## License |
| 70 | +Licensed under [the MIT license](LICENSE). |
0 commit comments