README.md
# Medium Editor for Rails
[![Gem Version](https://badge.fury.io/rb/medium-editor-rails.png)](http://badge.fury.io/rb/medium-editor-rails)
[![Code Climate](https://codeclimate.com/github/marjinal1st/medium-editor-rails.png)](https://codeclimate.com/github/marjinal1st/medium-editor-rails)
[![Dependency Status](https://gemnasium.com/marjinal1st/medium-editor-rails.svg)](https://gemnasium.com/marjinal1st/medium-editor-rails)
This gem integrates [Medium Editor](https://github.com/yabwe/medium-editor) with Rails asset pipeline.
## Version
The latest version of Medium Editor bundled by this gem is [5.23.2](https://github.com/yabwe/medium-editor/releases)
## Installation
Include **medium-editor-rails** in your Rails project's Gemfile:
```ruby
gem 'medium-editor-rails'
```
And then execute:
```bash
bundle install
```
## Configuration
Include javascript file in **app/assets/javascripts/application.js**:
```javascript
//= require medium-editor
```
Include stylesheet file in **app/assets/stylesheets/application.css**:
```scss
*= require medium-editor/medium-editor
```
You can also include themes from **themes** folder, example:
```scss
*= require medium-editor/themes/flat
```
For more themes, visit: [Medium Editor Themes](https://github.com/yabwe/medium-editor/wiki/Themes)
## Using Medium Editor with Rails
You need to initialize Medium Editor with any selector of div, example:
```html
<div class="editable"></div>
<script>
var editor = new MediumEditor('.editable', {
// options go here
});
</script>
```
For extra options, visit: [Medium Editor Options](https://github.com/yabwe/medium-editor#mediumeditor-options)
## Contributing
1. Fork it ( http://github.com/marjinal1st/medium-editor-rails/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request