Skip to content

Commit c78174b

Browse files
committed
[Issue #3] - Readme - Add documentation
1 parent be1f915 commit c78174b

2 files changed

Lines changed: 30 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@
44

55
### Fixes
66

7+
- [Issue #3] - Readme - Add documentation
78
- [Issue #2] - Bin - will not start

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,31 @@
11
# html-baker
22
Convert websites into flat-file websites
3+
4+
## Installation
5+
6+
```
7+
npm i -g StatelessSoftware/html-baker
8+
```
9+
10+
## Preperation
11+
12+
Create a config file `html-baker -c`
13+
Edit the config file and make sure everything is proper.
14+
15+
## Usage
16+
17+
Run `html-baker`
18+
19+
### Force clean build
20+
21+
To remove the build and rebuild, run `html-baker -f`
22+
23+
## Configuration
24+
25+
- **domains** - An array of domain urls to download
26+
- **input** - If you have an app locally to download from, you can have it auto-start with these options
27+
- **directory** - Location of the app
28+
- **runcmd** - Command to run (start) the app. i.e. - `npm start`
29+
- **output**
30+
- **directory** - Directory to bake into
31+
- **options** - Array of wget options

0 commit comments

Comments
 (0)