Skip to content

Commit 57351b4

Browse files
committed
Update README
1 parent c95c8ab commit 57351b4

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

Diff for: README.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ gStatic uses Go’s html/template and text/template libraries as the basis for t
1010
- [x] Write result to a public folder
1111
- [x] Add support for layouts
1212
- [x] Improve error handling
13-
- [ ] Add configuration
13+
- [x] Add configuration
1414
- [ ] Add documentation on how to do templates
1515

1616
## Common language
1717

18-
* Source is the folder that has all the html files.
19-
* Target is the folder where the website will be written.
18+
* sourceFolder is the folder that has all the html files.
19+
* targetFolder is the folder where the website will be written.
2020
* Template is an Html file.
2121
* Data-source is a file that variables to be use inside the html files.
2222

@@ -34,4 +34,12 @@ Example
3434
| ------------- |-------------|-----|
3535
| index.html | index.yaml | index.html will be rendered using variables on index.yaml |
3636
| aboutus.html | aboutus.yaml | aboutus.html will be rendered using variables on aboutus.yaml |
37-
| contactus.html | if no yaml file for contactus | contactus.html will be copied to Target as it is |
37+
| contactus.html | if no yaml file for contactus | contactus.html will be copied to Target as it is |
38+
39+
## Usage
40+
41+
> gstatic <sourceFolder> <targetFolder>
42+
43+
Use -h for help
44+
45+
> gstatic -h

0 commit comments

Comments
 (0)