include packaging changes

chrisvrose · Jun 25, 2019 · 41c950c · 41c950c
1 parent 650a8b4
commit 41c950c
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 25 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,5 @@
 # Builds
 index-*
-index.exe
 # Service Files
 servicefile.xml
 serviceScript.*

diff --git a/README.md b/README.md
@@ -1,2 +1,15 @@
 # xml-servicefile-parser
+
 Parse servicefile.xml from stock Android pieces to create a script to restore to stock
+
+## Executable
+
+### Building
+
+1. `npm i`
+2. `npm run package`
+
+### Usage
+
+1. Place alongside `servicefile.xml`.
+2. Run executable or `node test`, if using source.
diff --git a/package.json b/package.json
@@ -4,7 +4,8 @@
   "description": "Noob script to create scripts onn servicefile.xml",
   "main": "index.js",
   "scripts": {
-    "test": "node ."
+    "test": "node .",
+    "package":"pkg  index.js --out-path build/"
   },
   "repository": {
     "type": "git",

diff --git a/serviceScript.sh b/serviceScript.sh