Smoke is the most complete jQuery Plugin and designed for use with Bootstrap 3.
To get started, check out http://alfredobarron.github.io/smoke/#/.
- Quick Start
- Required
- Documentation
- How to Contribute
- Community
- Creators
- Collaborators
- Copyright and License
Several quick start options are available:
- Download the latest release.
- Clone the repo:
git clone https://github.com/alfredobarron/smoke.git. - Install with Bower:
bower install smoke. - Install with npm:
npm install smokejs.
Read the 'Getting Started' page for information on the plugin contents.
##Required
Smoke plugin requires the jQuery library and Bootstrap 3 framework.
##Documentation
If you'd like to read the documentation, you can do so here: http://alfredobarron.github.io/smoke/#/.
##How to Contribute
We love contributions and all pull requests are welcome. There are several ways to help out:
- If you have found a bug, please create an issue on GitHub
- Write test cases for open bug issues
- Write patches for open bug/feature issues (Bonus points if you can include test cases with your code!)
- Contribute to the documentation
There are a few guidelines that we need contributors to follow so that we have a chance of keeping on top of things.
If you want to contribute changes, it's best to avoid working directly on the master branch. We recommend working on the dev branch to avoid merge conflicts if you're regularly pulling in updates from origin.
##Community
- Join the official Slack room.
- Implementation help may be found at Stack Overflow (tagged
smoke).
##Creators
##Collaborators
##Copyright and License
Code and documentation (c) Copyright 2015 Alfredo Barron. Code published under license LGPL