aurelia-froala-editor - npm Package Compare versions

Comparing version 2.7.3 to 2.7.4

package.json

 {
   "name": "aurelia-froala-editor",
-  "version": "2.7.3",
+  "version": "2.7.4",
   "description": "Aurelia plugin for Froala WYSIWYG HTML rich text editor.",
@@ -60,3 +60,3 @@ "keywords": [
   "dependencies": {
-    "froala-editor": "^2.6.0",
+    "froala-editor": "^2.7.4",
     "aurelia-binding": "^1.0.0",
@@ -63,0 +63,0 @@ "aurelia-dependency-injection": "^1.0.0"

README.md

@@ -1,14 +0,20 @@
-# aurelia-froala-editor
+# Aurelia Froala WYSIWYG HTML Editor
 
->This package provides a custom element for the [Froala editor](https://www.froala.com/wysiwyg-editor) in [Aurelia](http://aurelia.io/).
+[![npm](https://img.shields.io/npm/v/aurelia-froala-editor.svg)](https://www.npmjs.com/package/aurelia-froala-editor)
+[![npm](https://img.shields.io/npm/dm/aurelia-froala-editor.svg)](https://www.npmjs.com/package/aurelia-froala-editor)
+[![npm](https://img.shields.io/npm/l/aurelia-froala-editor.svg)](https://www.npmjs.com/package/aurelia-froala-editor)
 
+>This package provides a custom element for the [Froala WYSIWYG HTML Editor](https://www.froala.com/wysiwyg-editor) in [Aurelia](http://aurelia.io/).
+
 ## Table of contents
 
 1. [Installation instructions](#installation-instructions)
-2. [Integration](#integration)
-   1. [With Aurelia CLI](#with-angular-cli)
+2. [Update editor instructions](#update-editor-instructions)
+3. [Integration](#integration)
+   1. [With Aurelia CLI](#with-aurelia-cli)
    2. [With Webpack](#with-webpack)
-   3. [With JSPM](#with-jspm)
-3. [Usage](#usage)
-4. [License](#license)
+   3. [With Easy Webpack](#with-easy-webpack)
+   4. [With JSPM](#with-jspm)
+4. [Usage](#usage)
+5. [License](#license)
 
@@ -20,5 +26,11 @@ ## Installation instructions
 ```bash
-npm install angular-froala-editor --save
+npm install aurelia-froala-editor --save
 ```
 
+## Update editor instructions
+
+```bash
+npm update froala-editor
+```
+
 ## Integration
@@ -167,3 +179,3 @@
   gulp.parallel(
-    ... 
+    ...
     copyAssets // Add this.
@@ -267,2 +279,64 @@ ),
 
+### With Easy Webpack
+
+To configure your project with Easy Webpack, follow the resources from Aurelia Docs: http://aurelia.io/hub.html#/doc/article/aurelia/framework/latest/setup-webpack/2 .
+
+```bash
+git clone [e-mail]:aurelia/skeleton-navigation.git
+cd skeleton-navigation/skeleton-esnext-webpack
+git reset --hard 8997a6f87339a2702f77aeaab7ede5bffe94437f
+npm install
+```
+
+#### Add aurelia-froala-editor
+
+- Install the aurelia plugin
+
+```bash
+npm install aurelia-froala-editor --save
+```
+
+- In your `src/main.js` or `src/main.ts` file add:
+
+```javascript
+import { PLATFORM } from "aurelia-pal";
+
+// Editor files.
+import "froala-editor/js/froala_editor.pkgd.min";
+
+...
+
+// Use the aurelia-froala-editor plugin.
+aurelia.use.plugin(PLATFORM.moduleName('aurelia-froala-editor'));
+```
+
+- In your `src/app.html` include CSS files and Froala Editor component:
+
+```html
+<require from="froala-editor/css/froala_editor.pkgd.min.css"></require>
+<require from="froala-editor/css/froala_style.min.css"></require>
+
+<froala-editor></froala-editor>
+```
+
+- In `package.json` file include the Aurelia Froala Editor plugin:
+
+```json
+"aurelia": {
+  "build": {
+    "resources": [
+      "aurelia-froala-editor/froala-editor"
+    ]
+  }
+}
+```
+
+#### Run application
+
+```bash
+npm run start
+```
+
+
+
 ### With JSPM
@@ -283,3 +357,3 @@
 
-#### 
+####
 
@@ -286,0 +360,0 @@ #### Add aurelia-froala-editor

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

48377

increased by3.8%

Number of lines in readme file

472

increased by18.59%

Worsened metrics

Number of package files

36

decreased by-5.26%

Dependency changes

• Updatedfroala-editor@^2.7.4