Version 0.1.0 🎉

README.md

@@ -0,0 +1,63 @@
+# ActiveAdmin Quill Editor [![Gem Version](https://badge.fury.io/rb/activeadmin_quill_editor.svg)](https://badge.fury.io/rb/activeadmin_quill_editor)
+
+An Active Admin plugin to use [Quill Rich Text Editor](https://github.com/quilljs/quill)
+
+![screenshot](screenshot.jpg)
+
+## Install
+
+- Update your Gemfile: `gem 'activeadmin_quill_editor'` (and execute *bundle*)
+- Add at the end of your ActiveAdmin styles (_app/assets/stylesheets/active_admin.scss_):
+```css
+@import 'activeadmin/quill_editor_input';
+```
+- Add at the end of your ActiveAdmin javascripts (_app/assets/javascripts/active_admin.js_):
+```js
+//= require activeadmin/quill_editor/quill
+//= require activeadmin/quill_editor_input
+```
+- Use the input with `as: :quill_editor` in Active Admin model conf
+
+Why 2 separated scripts? In this way you can include a different version of *quill editor* if you like.
+
+## Options
+
+**data-options**: permits to set *quill editor* options directly - see [options list](https://quilljs.com/docs/quickstart/)
+
+## Examples
+
+```ruby
+# ActiveAdmin article form conf:
+  form do |f|
+    f.inputs 'Article' do
+      f.input :title
+      f.input :description, as: :quill_editor
+      f.input :published
+    end
+    f.actions
+  end
+```
+
+Toolbar buttons configuration:
+
+```ruby
+f.input :description, as: :quill_editor, input_html: {data: {options: {modules: {toolbar: [['bold', 'italic', 'underline'], ['link']]}, placeholder: 'Type something...', theme: 'snow'}}}
+```
+
+## Notes
+
+- Upload functions (Images, Documents, Files, etc.) are not implemented yet
+
+## 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.
+
+## Contributors
+
+- [Mattia Roccoberton](http://blocknot.es) - creator, maintainer
+
+## License
+
+[MIT](LICENSE.txt)