@accordproject/markdown-editor - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

package.json

 {
   "name": "@accordproject/markdown-editor",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "A rich text editor that can read and write markdown text. Based on Slate.js.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -7,4 +7,18 @@ This is a React component for a rich text editor that can read and write [CommonMark](https://commonmark.org) Markdown text. The editor uses [Slate.js](https://slatejs.org).
 
-### Demo
+### Usage
 
+```
+npm install @accordproject/markdown-editor
+```
+
+```
+import MarkdownEditor from '../../src';
+
+ReactDOM.render(<MarkdownEditor />, document.getElementById('root'));
+```
+
+### Example
+
+For an example React App see the ./examples/ folder.
+
 A `TextArea` containing CommonMark synchronized with a `MarkdownEditor` component, rendered using Slate.js.
@@ -11,0 +25,0 @@

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

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 13 instances in 1 package

Improved metrics

Number of lines in readme file

46

increased by43.75%

Number of medium supply chain risk alerts

1

decreased by-92.86%

Worsened metrics

Total package byte prevSize

1351933

decreased by-84.87%

Number of package files

18

decreased by-64%

Lines of code

4920

decreased by-53.74%

No dependency changes