activeadmin_froala_editor 0.2.12 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4eaad489692a452ab6d50b1c297f8ba3457aad3a3a7e86bd570b0e9aa6491f4
-  data.tar.gz: 9a384dedfd3c5c058613132d69c4eb14a431cd3249dd373f054a7a8ea3ceb788
+  metadata.gz: 24b75e9d2a423503420d4bffd0c3947a5696027e8dec4d11342fe2d9523f54a0
+  data.tar.gz: 4d96ad2ee66cc30f461971db765f26412b7af7ae3b7e7a431543532f4e738ba7
 SHA512:
-  metadata.gz: bfdaad12113cb81a56f1597fc772f3772e9c710534aca9e0a600eae4f153bc9d74f0283576fc692f782ccfe932e9184accbb091e99c402faab5934653cee089e
-  data.tar.gz: d371560ffb3f92a0ebaafcd1358091b696df80e7831fb06923a7a828c4f90d949216426367f14dfa5c4849cab42bc3cb542a12efa38441e3f67ebe4e2eb50516
+  metadata.gz: b48b07c5256a4f212a0a4ab1ebf9164c293c5fadb8a40e9d8e3a4c04c9d20cdd796a9e3a510da191856d31b15baf261b597c36394d2473a41f37713f06c13c69
+  data.tar.gz: e8666daf4160167c30d8766a8203620fd4ffecb486558e0fe419ebc86a4ce1ea01cb0d4844f14d480c996b293cdf030e5c14747ee236f59db392d9c4b0206230

data/LICENSE.txt

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

data/README.md

@@ -1,4 +1,9 @@
-# ActiveAdmin Froala Editor [![Gem Version](https://badge.fury.io/rb/activeadmin_froala_editor.svg)](https://badge.fury.io/rb/activeadmin_froala_editor) [![CircleCI](https://circleci.com/gh/blocknotes/activeadmin_froala_editor.svg?style=svg)](https://circleci.com/gh/blocknotes/activeadmin_froala_editor)
+# ActiveAdmin Froala Editor
+[![gem version](https://badge.fury.io/rb/activeadmin_froala_editor.svg)](https://badge.fury.io/rb/activeadmin_froala_editor)
+[![gem downloads](https://badgen.net/rubygems/dt/activeadmin_froala_editor)](https://rubygems.org/gems/activeadmin_froala_editor)
+[![linters](https://github.com/blocknotes/activeadmin_froala_editor/actions/workflows/linters.yml/badge.svg)](https://github.com/blocknotes/activeadmin_froala_editor/actions/workflows/linters.yml)
+[![Specs Rails 6.1](https://github.com/blocknotes/activeadmin_froala_editor/actions/workflows/specs_rails61.yml/badge.svg)](https://github.com/blocknotes/activeadmin_froala_editor/actions/workflows/specs_rails61.yml)
+[![Specs Rails 7.0](https://github.com/blocknotes/activeadmin_froala_editor/actions/workflows/specs_rails70.yml/badge.svg)](https://github.com/blocknotes/activeadmin_froala_editor/actions/workflows/specs_rails70.yml)
 
 An Active Admin plugin to use [Froala WYSIWYG editor](https://github.com/froala/wysiwyg-editor) (jQuery required, font-awesome required & included). For Froala license / pricing see Froala website.
 
@@ -7,10 +12,17 @@ Features:
 - customizable options via data attributes in the form input;
 - plugins included, like images upload.
 
-![screenshot](screenshot.png)
+![screenshot](extra/screenshot.png)
+
+Please :star: if you like it.
 
 ## Install
-- After installing Active Admin, add to your Gemfile: `gem 'activeadmin_froala_editor'` (and execute *bundle*)
+
+After installing Active Admin, add to your Gemfile: `gem 'activeadmin_froala_editor'` (and execute *bundle*)
+
+If you installed Active Admin **without Webpacker** support:
+
+- Add a SASS/SCSS gem to your Gemfile (ex. `gem 'sassc'`)
 - Add at the end of your Active Admin styles (_app/assets/stylesheets/active_admin.scss_):
 ```css
 @import 'font-awesome/font-awesome';
@@ -23,7 +35,22 @@ Features:
 ```
 - Use the input with `as: :froala_editor` in Active Admin model conf
 
+Otherwise **with Webpacker**:
+
+- Execute in your project root:
+
+```sh
+yarn add blocknotes/activeadmin_froala_editor
+```
+
+- Add to your *app/javascript/packs/active_admin.js*:
+
+```js
+require('activeadmin_froala_editor')
+```
+
 ## Notes
+
 - To use this plugins with Active Admin 1.x please use the version [0.1.3](https://github.com/blocknotes/activeadmin_froala_editor/releases/tag/v0.1.3)
 - **data-options**: permits to set *froala editor* options directly from the form field (examples below) - see [options list](https://www.froala.com/wysiwyg-editor/docs/options)
 
@@ -72,16 +99,23 @@ Consider that this is just a basic example: images are uploaded as soon as they
 the *upload_admin_post_path*) and it doesn't provide a way to remove images (just deleting them from
 the editor will not destroy them, you'll need to implement a purge logic for that).
 
+## Changelog
+
+The changelog is available [here](CHANGELOG.md).
+
 ## 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).
 
 For Froala editor License: see [Froala website](https://froala.com/wysiwyg-editor/).