bootstrap-checkbox/README.md

A checkbox component based on Bootstrap framework

<p align="center"><img src="logo/logo.svg" alt="bootstrap-checkbox" height="200"></p>

# [Bootstrap-checkbox](https://vsn4ik.github.io/bootstrap-checkbox/)

[![npm version](https://img.shields.io/npm/v/bootstrap-checkbox.svg)](https://www.npmjs.com/package/bootstrap-checkbox)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Build Status](https://github.com/vsn4ik/bootstrap-checkbox/workflows/Test/badge.svg)](https://github.com/vsn4ik/bootstrap-checkbox/actions?workflow=Test)
[![devDependency Status](https://david-dm.org/vsn4ik/bootstrap-checkbox/dev-status.svg)](https://david-dm.org/vsn4ik/bootstrap-checkbox?type=dev)


## Quick start

Several quick start options are available:

* [Download the latest release](https://github.com/vsn4ik/bootstrap-checkbox/archive/v2.0.0.zip "Download Bootstrap-checkbox")
* Clone the repo: `git clone https://github.com/vsn4ik/bootstrap-checkbox.git`
* Install with [npm](https://www.npmjs.com): `npm install bootstrap-checkbox`
* Install with [yarn](https://yarnpkg.com): `yarn add bootstrap-checkbox`

### What's included

```
bootstrap-checkbox/
└── js/
    ├── i18n/
    │   └── ...
    ├── bootstrap-checkbox.js
    └── bootstrap-checkbox.min.js
```


## Examples

For some working examples, visit our [examples](https://vsn4ik.github.io/bootstrap-checkbox/#html-examples) section.


## Min Requirements

* Bootstrap 3.0.0
* jQuery 1.9.1


## Creators

**Vasilii A.**

* <https://github.com/vsn4ik>


## Copyright and license

Copyright Vasilii A., 2013&ndash;2018.

Licensed under [the MIT License][license].

[license]: https://github.com/vsn4ik/bootstrap-checkbox/blob/master/LICENSE