README.md in adminlte-rails-1.3.2 vs README.md in adminlte-rails-1.3.3
- old
+ new
@@ -1,9 +1,11 @@
-# Adminlte::Rails
+# AdminLTE Rails gem
-TODO: Write a gem description
+[AdminLTE](http://www.almsaeedstudio.com/) is a premium Bootstrap theme for backend.
+The **AdminLTE Rails** gem integrates **AdminLTE** theme with the Rails asset pipeline.
+
## Installation
Add this line to your application's Gemfile:
gem 'adminlte-rails'
@@ -16,10 +18,41 @@
$ gem install adminlte-rails
## Usage
-TODO: Write usage instructions here
+### Include adminlte-rails javascript assets
+
+Add the following to your `app/assets/javascripts/application.js`:
+
+ //= require bootstrap.min
+ //= require admin-lte
+
+### Include adminlte-rails stylesheet assets
+
+Add the following to your `app/assets/stylesheets/application.css`:
+
+ *= require bootstrap
+ *= require font-awesome
+ *= require ionicons
+ *= require admin-lte
+
+If you want to use additional features, add more these lines to your `app/assets/stylesheets/application.css`:
+
+ *= require iCheck/all
+ *= require datatables/dataTables.bootstrap
+
+## Version
+
+1.3.2 (AdminLTE 1.3.0)
+
+## Changelog
+
+View [CHANGELOG](CHANGELOG.md)
+
+## License
+
+AdminLTE-Rails is released under the [MIT License](http://www.opensource.org/licenses/MIT).
## Contributing
1. Fork it ( https://github.com/[my-github-username]/adminlte-rails/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)