Skip to content

Commit c008600

Browse files
committed
docs: Update README to include caching behavior and new script generation instructions
1 parent 09e74f1 commit c008600

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Running it with a directory of PNG files would look like this:
2626

2727
```
2828
$ ./convert-pngs
29+
✓ Script generated successfully
2930
Creating output directory
3031
Convering input/1.png
3132
Convering input/2.png
@@ -36,6 +37,18 @@ Running pngcrush on output/3.png
3637
Done!
3738
```
3839

40+
Running it again will use the cache and not generate any new scripts:
41+
42+
```
43+
$ ./convert-pngs
44+
✓ Cached script found
45+
Creating output directory
46+
Convering input/1.png
47+
...
48+
```
49+
50+
If you want to generate a new script, use the `--no-cache` flag.
51+
3952
## Prerequisites
4053

4154
- [Go](https://go.dev/) (1.22 or later)

0 commit comments

Comments
 (0)