@enotes/groot - npm Package Compare versions

Comparing version 1.0.3-beta to 1.0.4-beta

package.json

 {
   "name": "@enotes/groot",
   "description": "Groot, a content tree.",
-  "version": "1.0.3-beta",
+  "version": "1.0.4-beta",
   "main": "src/groot.js",
@@ -6,0 +6,0 @@ "scripts": {

README.md

@@ -8,6 +8,7 @@ # Groot
 - [Groot](#groot)
+    - [Installation](#installation)
+        - [As an ES2015 module](#as-an-es2015-module)
+        - [As an ES5 script](#as-an-es5-script)
+    - [Building the project](#building-the-project)
     - [Usage](#usage)
-        - [Installation](#installation)
-            - [As an ES2015 module](#as-an-es2015-module)
-            - [As an ES5 script](#as-an-es5-script)
         - [Creating your tree](#creating-your-tree)
@@ -25,8 +26,6 @@ - [Adding custom meta-data](#adding-custom-meta-data)
 
-## Usage
+## Installation
 
-### Installation
+### As an ES2015 module
 
-#### As an ES2015 module
-
 Install Groot with npm.
@@ -44,3 +43,3 @@
 
-#### As an ES5 script
+### As an ES5 script
 
@@ -62,2 +61,21 @@ Copy the Groot assets in the `dist/` folder to the appropriate vendor location in your project structure, e.g., `scripts/vendor/groot/`.
 
+## Building the project
+
+Install the Groot npm dependencies to ensure that the build tools are present.
+
+```
+$ npm install
+```
+
+The Groot distribution artifacts are pre-built and are located in the `dist/` folder. These assets are re-built with the command:
+
+```
+$ npm run-script build
+```
+
+**The build script relies on bash shell commands and will not work correctly in non-bash environments.**
+
+
+## Usage
+
 ### Creating your tree
@@ -64,0 +82,0 @@

src/groot.js

@@ -1532,3 +1532,1 @@ 'use strict';
 };
-
-window.Groot = Groot;

webpack.config.js

@@ -11,3 +11,3 @@ 'use strict';
             'babel-polyfill',
-            path.join(__dirname, 'src', 'groot.js'),
+            path.join(__dirname, 'src', 'es5-wrapper.js'),
         ],
@@ -14,0 +14,0 @@ 'demo': [

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

Number of package files

51

increased by2%

Lines of code

25570

increased by0.03%

Number of lines in readme file

311

increased by6.14%

Worsened metrics

Total package byte prevSize

2497973

decreased by-0.04%

No dependency changes