wysiwyg-rails 1.2.7 → 4.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 112144032bba9b2db59b9c369370d2259261c64d
-  data.tar.gz: 5563ea92760e5b7c7c73d5b6e5ea6c3908fc3aa5
+SHA256:
+  metadata.gz: e411f932346d0c724fe55cb53007295485f8cefde525cc6daa65d7d18bde3459
+  data.tar.gz: 585022fa57b1780de68c229eabc327d20bc64d2ad6e4d1bdfb0018671ebcffa2
 SHA512:
-  metadata.gz: 61191023384353380b9e01155dfe6d2c709b4280232d88b5e7999963bc77bee8e906ee5f21a2aafa9d0c42a8532af2749d7d36c139c7f7a379956612a3ff78eb
-  data.tar.gz: 20fe30ad653d901e51b8da3e5d31709a4cafb289ce852ff81967504262b5e7719ae6387fa53fbe8f42e201d1b171d5d61c8eff74c17e8a1134bc9e70d16a0ac8
+  metadata.gz: 05504d424f2152c9f8b63c210915e78e851d7eb829f351ab60d3ecdab83fc871c37bb690924c58e76bbc8c692650cc7e97f27db88d98eac96ee8cf07c35dac71
+  data.tar.gz: b1e6b2dc29bd1aeadca06970e126db25744eb05c6ab056bc81b1b09b2ca27ac3ecdd270f9e0c73d1e9b58f32e46a506e087b95cd0104361b9ee135963558f9d1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Froala
+Copyright (c) 2015 Froala
 
 MIT License
 

data/README.md

@@ -1,6 +1,11 @@
-# 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
 
-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.
+[![Travis](https://img.shields.io/travis/froala/wysiwyg-rails.svg)](http://travis-ci.org/froala/wysiwyg-rails)
+[![Gem](https://img.shields.io/gem/v/wysiwyg-rails.svg)](https://rubygems.org/gems/wysiwyg-rails/versions/2.1.0)
+[![Gem](https://img.shields.io/gem/dt/wysiwyg-rails.svg)](https://rubygems.org/gems/wysiwyg-rails/versions/2.1.0)
+[![license](https://img.shields.io/github/license/froala/wysiwyg-rails.svg)](https://rubygems.org/gems/wysiwyg-rails/versions/2.1.0)
+
+>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
 
@@ -11,61 +16,133 @@ gem "wysiwyg-rails"
 ```
 
 and run `bundle install`.
-
 ## Usage
+In your index.html.erb add
+```
+<script type="text/javascript" src = "../../assets/froala_editor.pkgd.min.js"></script>
+```
+To use third-party plugins  add
+```
+<script type="text/javascript" src = "../../assets/third_party/font_awesome.min.js"></script>
+<script type="text/javascript" src = "../../assets/third_party/embedly.min.js"></script>
+<script type="text/javascript" src = "../../assets/third_party/image_tui.min.js"></script>
+<script type="text/javascript" src = "../../assets/third_party/spell_checker.min.js"</script>
+```
+Initialize editor by adding below in body of index.html.erb
+```
+ new FroalaEditor('#edit', {
+   
+  })
+```
+## Options
+You can pass options to editor by including these in index.html.erb
+```
+new FroalaEditor('#editor', {
+options :  value
+});
+```
+
+## Include in assets
 
-In your `application.css`, include the css file:
+In your `application.css.scss`, include the css file:
 
 ```css
 /*
- *= require froala_editor.min.css
- *= require froala_style.min.css
- *= require font-awesome
+ @import "froala_editor.min";
+ @import "froala_style.min";
  */
 ```
 
 If you want to use the dark theme, then you have to include `themes/dark.min.css` file too.
 
-In your `application.js`, include the JS file:
+In your `application.js.coffee`, include the JS file:
+
+```coffeescript
+#= require froala_editor.min.js
+
+new FroalaEditor('selector',{
+  
+});
+```
 
-```javascript
-//
-//= 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.coffee` and `application.css.scss`.
+
+```coffeescript
+# Include other plugins.
+#= require plugins/align.min.js
+#= require plugins/char_counter.min.js
+#= require plugins/code_beautifier.min.js
+#= require plugins/code_view.min.js
+#= require plugins/colors.min.js
+#= require plugins/emoticons.min.js
+#= 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_class.min.js
+#= require plugins/inline_style.min.js
+#= require plugins/line_breaker.min.js
+#= require plugins/line_height.min.js
+#= require plugins/link.min.js
+#= require plugins/lists.min.js
+#= require plugins/paragraph_format.min.js
+#= require plugins/paragraph_style.min.js
+#= require plugins/print.min.js
+#= require plugins/quick_insert.min.js
+#= require plugins/quote.min.js
+#= require plugins/save.min.js
+#= require plugins/table.min.js
+#= require plugins/special_characters.min.js
+#= require plugins/url.min.js
+#= require plugins/video.min.js
+
+#= require third_party/embedly.min.js
+#= require third_party/font_awesome.min.js
+#= require third_party/image_tui.min.js
+#= require third_party/spell_checker.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`.
-```javascript
-// Include other plugins.
-//= require plugins/block_styles.min.js
-//= require plugins/colors.min.js
-//= require plugins/media_manager.min.js
-//= require plugins/tables.min.js
-//= require plugins/video.min.js
-//= require plugins/font_family.min.js
-//= require plugins/font_size.min.js
-//= require plugins/file_upload.min.js
-//= require plugins/lists.min.js
-//= require plugins/char_counter.min.js
-//= require plugins/fullscreen.min.js
-//= require plugins/urls.min.js
-//= require plugins/inline_styles.min.js
-//= require plugins/entities.min.js
+```css
+@import 'plugins/char_counter.min.css';
+@import 'plugins/code_view.min.css';
+@import 'plugins/colors.min.css';
+@import 'plugins/emoticons.min.css';
+@import 'plugins/file.min.css';
+@import 'plugins/fullscreen.min.css';
+@import 'plugins/help.min.css';
+@import 'plugins/image_manager.min.css';
+@import 'plugins/image.min.css';
+@import 'plugins/line_breaker.min.css';
+@import 'plugins/quick_insert.min.css';
+@import 'plugins/special_characters.min.css';
+@import 'plugins/table.min.css';
+@import 'plugins/video.min.css';
+
+@import 'third_party/embedly.min.css';
+@import 'third_party/image_tui.min.css';
+@import 'third_party/spell_checker.min.css';
 ```
 
 Similar, if you want to use language translation you have to include the translation file.
-```javascript
-// Include Language if needed
-//= require langs/ro.js
+
+```coffeescript
+# Include Language if needed
+#= require languages/ro.js
 ```
 
 Then restart your web server if it was previously running.
 
-Congrats all is done!
+## 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
 
-The `wysiwyg-rails` project is under MIT license.
+The `wysiwyg-rails` project is under MIT license. However, in order to use Froala WYSIWYG HTML Editor plugin you should purchase a license for it.
 
-Froala Editor has [4 different licenses](https://froala.com/wysiwyg-editor/pricing) for commercial use.
+Froala Editor has [3 different licenses](https://froala.com/wysiwyg-editor/pricing).
 For details please see [License Agreement](https://froala.com/wysiwyg-editor/terms).