Merge pull request #5 from StatelessSoftware/v0.0.2

V0.0.2

Author: DrewImm

CHANGELOG.md

@@ -0,0 +1,9 @@
+# html-baker
+
+## [0.0.2] - 2018-03-31
+
+### Fixes
+
+- [Issue #4] - Default config file outdated
+- [Issue #3] - Readme - Add documentation
+- [Issue #2] - Bin - will not start

README.md

@@ -1,2 +1,31 @@
 # html-baker
 Convert websites into flat-file websites
+
+## Installation
+
+```
+npm i -g StatelessSoftware/html-baker
+```
+
+## Preperation
+
+Create a config file `html-baker -c`
+Edit the config file and make sure everything is proper.
+
+## Usage
+
+Run `html-baker`
+
+### Force clean build
+
+To remove the build and rebuild, run `html-baker -f`
+
+## Configuration
+
+- **domains** - An array of domain urls to download
+- **input** - If you have an app locally to download from, you can have it auto-start with these options
+    - **directory** - Location of the app
+    - **runcmd** - Command to run (start) the app. i.e. - `npm start`
+- **output**
+    - **directory** - Directory to bake into
+- **options** - Array of wget options

bin/htmlbaker.js

@@ -1,3 +1,3 @@
-#!/user/bin/env node
+#!/usr/bin/env node
 
 var htmlbaker = require("../index.js");

config.json

@@ -1,22 +1,22 @@
 {
-    "baker": {
-        "domains": [
-            "localhost:3000"
-        ],
-        "input": {
-            "directory": "./dist",
-            "runcmd": "npm start"
-        },
-        "output": {
-            "directory": "./docs"
-        },
-        "options": [
-            "recursive",
-            "page-requisites",
-            "html-extension",
-            "convert-links",
-            "restrict-file-names=windows",
-            "no-parent"
-        ]
-    }
-}
+	"baker": {
+		"domains": [
+			"localhost:3000"
+		],
+		"input": {
+			"directory": "dist",
+			"runcmd": "npm start"
+		},
+		"output": {
+			"directory": "./docs"
+		},
+		"options": [
+			"--recursive",
+			"--page-requisites",
+			"--html-extension",
+			"--convert-links",
+			"--restrict-file-names=windows",
+			"--no-parent"
+		]
+	}
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-baker",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Convert websites into flat-file websites",
   "main": "index.js",
   "bin": {