Skip to content

Commit 551dea4

Browse files
committed
usage to readme
1 parent a761802 commit 551dea4

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

main.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ func main() {
4242

4343
flag.StringVar(&target, "target", wd, "Path to write changed files to.")
4444
flag.BoolVar(&force, "force", false, "Execute all changes without asking.")
45-
flag.BoolVar(&debug, "debug", false, "Print extra information.")
46-
flag.BoolVar(&clean, "clean", false, "Clean-up target dir.")
45+
flag.BoolVar(&debug, "debug", false, "Print debug information.")
46+
flag.BoolVar(&clean, "clean", false, "Remove all files and dirs from target, but only if target differs from working dir.")
4747
flag.BoolVar(&quartz, "quartz", false, "Prepare frontmatter for Quartz publishing.")
48-
flag.BoolVar(&reformat, "reformat", false, "Replace frontmatter with this tool format and fix ending newline.")
48+
flag.BoolVar(&reformat, "reformat", false, "Replace frontmatter with this tool format and fix ending newlines.")
4949
flag.BoolVar(&fixChtimeFromGit, "git-chtime", false, "Change files chtime from git, useful right after git clone.")
5050
flag.Parse()
5151

readme.md

+19
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,22 @@
44
Basically adding `title` and `lastmod` frontmatter attributes, and little formatting.
55
There are further feature possibilities, such as preprocessing of embedded linked content, that are hard to implement solely in hugo templates, as done in Quartz :/
66
**Written in Go!**
7+
8+
## Usage
9+
```
10+
Usage of obsifix:
11+
-clean
12+
Remove all files and dirs from target, but only if target differs from working dir.
13+
-debug
14+
Print debug information.
15+
-force
16+
Execute all changes without asking.
17+
-git-chtime
18+
Change files chtime from git, useful right after git clone.
19+
-quartz
20+
Prepare frontmatter for Quartz publishing.
21+
-reformat
22+
Replace frontmatter with this tool format and fix ending newlines.
23+
-target string
24+
Path to write changed files to. (default "/home/tikinang/code/go/obsifix")
25+
```

0 commit comments

Comments
 (0)