l5x-js - npm Package Compare versions

Comparing version 0.1.1-alpha.3 to 0.1.1-alpha.4

package.json

 {
     "name": "l5x-js",
-    "version": "0.1.1-alpha.3",
+    "version": "0.1.1-alpha.4",
     "description": "A tool to help with parsing and generating Allen Bradley L5X files.",
@@ -5,0 +5,0 @@ "main": "./src/index.js",

README.md

@@ -7,2 +7,3 @@
   <p>
+  <a href="https://www.npmjs.com/package/l5x-js"><img src="https://img.shields.io/npm/v/l5x-js.svg?style=flat-square" alt="npm" /></a>
   <a href="https://gitter.im/L5XJS/Lobby"><img src="https://img.shields.io/gitter/room/L5XJS/nw.js.svg?style=flat-square" alt="Gitter" /></a>
@@ -19,4 +20,32 @@ <a href="https://github.com/cmseaton42/L5XJS/blob/master/LICENSE"><img src="https://img.shields.io/github/license/cmseaton42/L5XJS.svg?style=flat-square" alt="license" /></a>
 
-> **NOTE**
->
-> More documentation to follow as project matures. 
+## Prerequisites
+
+latest version of [NodeJS](https://nodejs.org/en/)
+
+## Getting Started
+
+Install with npm
+
+```
+npm install l5x-js --save
+```
+## The API
+
+How the heck does this thing work anyway? Great question!
+
+
+
+## Built With
+
+* [NodeJS](https://nodejs.org/en/) - The Engine
+* [javascript - ES2017](https://maven.apache.org/) - The Language
+
+## Contributers
+
+* **Canaan Seaton** - *Owner* - [GitHub Profile](https://github.com/cmseaton42) - [Personal Website](http://www.canaanseaton.com/)
+
+Wanna *become* a contributor? [Here's](https://github.com/cmseaton42/node-ethernet-ip/blob/master/CONTRIBUTING.md) how!
+
+## License
+
+This project is licensed under the MIT License - see the [LICENCE](https://github.com/cmseaton42/node-ethernet-ip/blob/master/LICENSE) file for details

src/document/index.js

@@ -26,3 +26,3 @@ const fs = require("fs");
             // Start from existing L5X file
-            this._dom = xml2js(fs.readFileSync(resolve(__dirname, filepath)), "utf8");
+            this._dom = xml2js(fs.readFileSync(resolve(filepath)), "utf8");
         } else if (document_tree) {
@@ -599,3 +599,3 @@ // Set document to incoming document tree
     export(filepath) {
-        fs.writeFileSync(resolve(__dirname, filepath), this.toString());
+        fs.writeFileSync(resolve(filepath), this.toString());
     }
@@ -602,0 +602,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

Improved metrics

Total package byte prevSize

29451

increased by3%

Number of lines in readme file

50

increased by150%

No dependency changes