v0.2.8

Author: blocknotes

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017 Mattia Roccoberton
+Copyright (c) 2017-2020 Mattia Roccoberton
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.md

@@ -1,38 +1,42 @@
-# ActiveAdmin Medium Editor [![Gem Version](https://badge.fury.io/rb/activeadmin_medium_editor.svg)](https://badge.fury.io/rb/activeadmin_medium_editor) [![CircleCI](https://circleci.com/gh/blocknotes/activeadmin_medium_editor.svg?style=svg)](https://circleci.com/gh/blocknotes/activeadmin_medium_editor)
+# Active Admin Medium Editor [![Gem Version](https://badge.fury.io/rb/activeadmin_medium_editor.svg)](https://badge.fury.io/rb/activeadmin_medium_editor) [![CircleCI](https://circleci.com/gh/blocknotes/activeadmin_medium_editor.svg?style=svg)](https://circleci.com/gh/blocknotes/activeadmin_medium_editor)
 
 An Active Admin plugin to use [medium-editor](https://github.com/yabwe/medium-editor), a compact and clean WYSIWYG editor.
 
 ![screenshot](screenshot.png)
 
-*Usage*: select some text in the input, a pop-up menu is shown with the available buttons
+## Usage
+- After the installation, select some text in the editor
+- A pop-up menu is shown with the available buttons
+- Click on a button and the effect will be applied to the selected text
 
 ## Install
-
-- Add to your Gemfile:
-`gem 'activeadmin_medium_editor'`
-- Execute bundle
-- Add at the end of your ActiveAdmin styles (_app/assets/stylesheets/active_admin.scss_):
-```css
+- After installing Active Admin, add to your Gemfile: `gem 'activeadmin_medium_editor'` (and execute *bundle*)
+- Add at the end of your Active Admin styles (_app/assets/stylesheets/active_admin.scss_):
+```scss
+@import 'activeadmin/medium_editor/medium_editor';
 @import 'activeadmin/medium_editor_input';
-@import 'activeadmin/medium_editor/themes/default.css'; // or another theme
+@import 'activeadmin/medium_editor/themes/default'; // or another theme
 ```
-- Add at the end of your ActiveAdmin javascripts (_app/assets/javascripts/active_admin.js_):
+- Add at the end of your Active Admin javascripts (_app/assets/javascripts/active_admin.js_):
 ```js
 //= require activeadmin/medium_editor/medium_editor
 //= require activeadmin/medium_editor_input
 ```
 - Use the input with `as: :medium_editor` in Active Admin model conf
 
-Why 2 separated scripts? In this way you can include a different version of *medium-editor* if you like.
+Why 2 separated scripts/styles? In this way you can include a different version of *medium-editor* if you like.
 
-## Options
+> **UPDATE FROM VERSION < 2.8**: please change your _app/assets/stylesheets/active_admin.scss_ using the new import lines above
 
+## Options
 **data-options**: permits to set *medium-editor* options directly - see [options list](https://github.com/yabwe/medium-editor#mediumeditor-options)
 
 ## Examples
 
+### Basic usage
+
 ```ruby
-# ActiveAdmin article form conf:
+# Active Admin article form conf:
   form do |f|
     f.inputs 'Article' do
       f.input :title
@@ -43,26 +47,24 @@ Why 2 separated scripts? In this way you can include a different version of *med
   end
 ```
 
-Some more buttons:
+### Buttons configuration
 
-`f.input :description, as: :medium_editor, input_html: { data: { options: '{"spellcheck":false,"toolbar":{"buttons":["bold","italic","underline","anchor","orderedlist","unorderedlist","strikethrough","subscript","superscript","pre","h1","h2","h3","h4","h5","h6","html"]}}' } }`
+```ruby
+f.input :description, as: :medium_editor, input_html: { data: { options: '{"spellcheck":false,"toolbar":{"buttons":["bold","italic","underline","anchor","orderedlist","unorderedlist","strikethrough","subscript","superscript","pre","h1","h2","h3","h4","h5","h6","html"]}}' } }
+```
 
 ## Notes
-
-With the current version of Medium Editor some default buttons seem to not work properly, from my test they are: "indent", "outdent", "quote", "justifyLeft", "justifyCenter", "justifyRight", "justifyFull"
-
-If some of this feature are needed I could suggest to override the button behavior or to use custom style classes. See the Medium Editor documentation for details.
+- With the current version of Medium Editor some default buttons seem to not work properly, from my test they are: "indent", "outdent", "quote", "justifyLeft", "justifyCenter", "justifyRight", "justifyFull"
+- If some of this feature are needed I could suggest to override the button behavior or to use custom style classes. See the Medium Editor documentation for details.
 
 ## Do you like it? Star it!
-
 If you use this component just star it. A developer is more motivated to improve a project when there is some interest.
 
-Take a look at [other ActiveAdmin components](https://github.com/blocknotes?utf8=✓&tab=repositories&q=activeadmin&type=source) that I made if you are curious.
+Take a look at [other Active Admin components](https://github.com/blocknotes?utf8=✓&tab=repositories&q=activeadmin&type=source) that I made if you are curious.
 
 ## Contributors
-
 - [Mattia Roccoberton](http://blocknot.es): author
+- The good guys that opened issues and pull requests from time to time
 
 ## License
-
-[MIT](LICENSE.txt)
+- The gem is available as open-source under the terms of the [MIT](LICENSE.txt)

lib/activeadmin/medium_editor/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveAdmin
   module MediumEditor
-    VERSION = '0.2.4'
+    VERSION = '0.2.8'
   end
 end