diff --git a/README.md b/README.md index 19d1ac3..f26af6e 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ -# ActiveAdmin Quill Editor [![Gem Version](https://badge.fury.io/rb/activeadmin_quill_editor.svg)](https://badge.fury.io/rb/activeadmin_quill_editor) [![CircleCI](https://circleci.com/gh/blocknotes/activeadmin_quill_editor.svg?style=svg)](https://circleci.com/gh/blocknotes/activeadmin_quill_editor) +# ActiveAdmin Quill Editor [![Gem Version](https://badge.fury.io/rb/activeadmin_quill_editor.svg)](https://badge.fury.io/rb/activeadmin_quill_editor) [![Specs](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/specs.yml/badge.svg)](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/specs.yml) An Active Admin plugin to use [Quill Rich Text Editor](https://github.com/quilljs/quill) in form fields. ![screenshot](screenshot.png) ## Install + After installing Active Admin, add to your Gemfile: `gem 'activeadmin_quill_editor'` (and execute *bundle*) If you installed Active Admin without Webpacker support (default for now): @@ -34,6 +35,7 @@ require('activeadmin_quill_editor') ``` ## Usage + In your Active Admin models, form configuration, set the text inputs with `as: :quill_editor` where needed. **data-options**: permits to set *quill editor* options directly - see [options list](https://quilljs.com/docs/configuration/) @@ -61,6 +63,7 @@ f.input :description, as: :quill_editor, input_html: { data: { options: { module ``` ### ImageUploader plugin + This plugin allows to upload images to the server (instead of storing them in *base64* by default), reference [here](https://github.com/NoelOConnell/quill-image-uploader). ```ruby @@ -87,13 +90,16 @@ the *upload_admin_post_path*) and it doesn't provide a way to remove images (jus the editor will not destroy them, you'll need to implement a purge logic for that). ## 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. My other [Active Admin components](https://github.com/blocknotes?utf8=✓&tab=repositories&q=activeadmin&type=source). Or consider offering me a coffee, it's a small thing but it is greatly appreciated: [about me](https://www.blocknot.es/about-me). ## Contributors + - [Mattia Roccoberton](http://blocknot.es): author - The good guys that opened issues and pull requests from time to time ## License + The gem is available as open-source under the terms of the [MIT](LICENSE.txt).