README.md in wysiwyg-rails-2.3.5 vs README.md in wysiwyg-rails-2.4.0

- old
+ new

@@ -1,8 +1,8 @@ -# wysiwyg-rails [![Gem Version](https://badge.fury.io/rb/wysiwyg-rails.png)](http://badge.fury.io/rb/wysiwyg-rails) [![Build Status](https://secure.travis-ci.org/froala/wysiwyg-rails.png)](http://travis-ci.org/froala/wysiwyg-rails) +# Rails Froala WYSIWYG HTML Editor [![Gem Version](https://badge.fury.io/rb/wysiwyg-rails.png)](http://badge.fury.io/rb/wysiwyg-rails) [![Build Status](https://secure.travis-ci.org/froala/wysiwyg-rails.png)](http://travis-ci.org/froala/wysiwyg-rails) -wysiwyg-rails provides the [Froala WYSIWYG HTML Editor](https://froala.com/wysiwyg-editor) javascript and stylesheets as a Rails engine for use with the asset pipeline. +>wysiwyg-rails provides the [Froala WYSIWYG HTML Editor](https://froala.com/wysiwyg-editor) javascript and stylesheets as a Rails engine for use with the asset pipeline. ## Installation Add this to your Gemfile: @@ -10,11 +10,11 @@ gem "wysiwyg-rails" ``` and run `bundle install`. -## Include in your assets +## Include in assets In your `application.css`, include the css file: ```css /* @@ -33,10 +33,11 @@ //= require froala_editor.min.js // ``` If you need to use any of the [Available Plugins](https://froala.com/wysiwyg-editor/docs/plugins), then you should include those too in your `application.js` and `application.css`. + ```javascript // Include other plugins. //= require plugins/align.min.js //= require plugins/char_counter.min.js //= require plugins/code_beautifier.min.js @@ -46,10 +47,11 @@ //= require plugins/entities.min.js //= require plugins/file.min.js //= require plugins/font_family.min.js //= require plugins/font_size.min.js //= require plugins/fullscreen.min.js +//= require plugins/help.min.js //= require plugins/image.min.js //= require plugins/image_manager.min.js //= require plugins/inline_style.min.js //= require plugins/line_breaker.min.js //= require plugins/link.min.js @@ -70,27 +72,29 @@ *= require plugins/code_view.min.css *= require plugins/colors.min.css *= require plugins/emoticons.min.css *= require plugins/file.min.css *= require plugins/fullscreen.min.css + *= require plugins/help.min.css *= require plugins/image_manager.min.css *= require plugins/image.min.css *= require plugins/line_breaker.min.css *= require plugins/quick_insert.min.css *= require plugins/table.min.css *= require plugins/video.min.css */ ``` Similar, if you want to use language translation you have to include the translation file. + ```javascript // Include Language if needed //= require languages/ro.js ``` Then restart your web server if it was previously running. -## Initialize Froala Editor +## Initialize Editor Details about initializing the editor can be found in the [Froala WYSIWYG Editor official documentation](https://www.froala.com/wysiwyg-editor/docs). ## License