README.md in chaltron-1.0.0 vs README.md in chaltron-1.0.1
- old
+ new
@@ -3,10 +3,18 @@
[![Coverage Status](https://coveralls.io/repos/vicvega/chaltron/badge.svg?branch=master&service=github)](https://coveralls.io/github/vicvega/chaltron?branch=master)
[![Code Climate](https://codeclimate.com/github/vicvega/chaltron/badges/gpa.svg)](https://codeclimate.com/github/vicvega/chaltron)
[![PullReview stats](https://www.pullreview.com/github/vicvega/chaltron/badges/master.svg?)](https://www.pullreview.com/github/vicvega/chaltron/reviews/master)
[![security](https://hakiri.io/github/vicvega/chaltron/master.svg)](https://hakiri.io/github/vicvega/chaltron/master)
+## Important note
+
+**The latest chaltron release (1.x) targets bootstrap v4.**
+
+If you are using bootstrap v3, refer to the [bootstrap3](https://github.com/vicvega/chaltron/tree/bootstrap3) branch (chaltron version 0.x).
+
+## Usage
+
In a fresh new rails application simply add to your `Gemfile`
```ruby
gem 'chaltron'
```
and install
@@ -42,10 +50,10 @@
Chaltron is powered by
* [devise](https://github.com/plataformatec/devise/)
* [cancancan](https://github.com/CanCanCommunity/cancancan/)
- * [bootstrap](https://github.com/twbs/bootstrap-sass)
+ * [bootstrap](https://github.com/twbs/bootstrap-rubygem)
* [font-awesome](https://github.com/FortAwesome/font-awesome-sass)
* [datatables](http://datatables.net/)
Refer to [wiki pages](https://github.com/vicvega/chaltron/wiki) for further instructions