Skip to content

Commit b729b0a

Browse files
committed
doc: document application
1 parent 0e4ff56 commit b729b0a

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,39 @@ Perfect for creating professional, customizable PDF documents as a service.
1111
## Install
1212

1313
``` bash
14-
go install github.com/BuddhiLW/AutoPDF/cmd/AutoPDF@latest
15-
```
16-
17-
## Testing
18-
19-
``` bash
20-
go test ./...
14+
go install github.com/BuddhiLW/AutoPDF/cmd/autopdf@latest
2115
```
2216

2317
## Usage
2418

19+
### Build
20+
2521
``` bash
2622
cd ./internal/autopdf/test-data
2723

28-
autopdf build template.tex config.yaml
29-
cat out/output.pdf
24+
autopdf build template.tex config.yaml # [optional: `clean`]
25+
file out/output.pdf
3026
```
31-
3227
Should output:
3328

3429
```
3530
file out/output.pdf
3631
out/output.pdf: PDF document, version 1.5
3732
```
3833

34+
### Clean up auxiliary files
35+
36+
``` bash
37+
autopdf clean <path-to-output-directory>
38+
```
39+
40+
Or, more conveniently, you can use the `build` command with the `clean` flag:
41+
42+
``` bash
43+
autopdf build template.tex config.yaml clean
44+
```
45+
46+
3947
## License
4048

4149
This project is licensed under the [Apache License 2.0](LICENSE).

0 commit comments

Comments
 (0)