Skip to content

Commit dca4f92

Browse files
committed
docs: update options, example and screenshot
1 parent 26f4b38 commit dca4f92

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,19 +63,19 @@ clish -f file.php -o file.png
6363
6464
#### Options
6565

66-
Parameter options.
66+
Parameter options:
6767

6868
```
69-
[-e|--echo] Forces echo to STDOUT when --output is passed
70-
[-f|--file] Input PHP file to highlight and/or export
71-
(will read from piped input if file not given)
72-
[-F|--font] Font to use for export to png
73-
[-h|--help] Show help
74-
[-o|--output] Output filepath where PNG image is exported
75-
[-v|--verbosity] Verbosity level
76-
[-V|--version] Show version
69+
[-e|--echo] Forces echo to STDOUT when --output is passed
70+
[-f|--file] Input PHP file to highlight and/or export
71+
(will read from piped input if file not given)
72+
[-F|--font] Font to use for export to png
73+
[-l|--with-line-no] Highlight with line number
74+
[-o|--output] Output filepath where PNG image is exported
7775
```
7876

77+
> Run `clish -h` to show help.
78+
7979
##### Examples
8080

8181
```sh
@@ -84,6 +84,7 @@ Parameter options.
8484
bin/clish < file.php # from redirected stdin
8585
bin/clish --file file.php --output file.png # export
8686
bin/clish --file file.php --output file.png --echo # print + export
87+
bin/clish --file file.php --with-line-no # print with lineno
8788
bin/clish -f file.php -o file.png -F dejavu # export in dejavu font
8889
```
8990

@@ -118,6 +119,10 @@ See [example usage](./example.php). Here's how the export looks like:
118119

119120
![adhocore/cli-syntax](./example.png)
120121

122+
---
123+
And with line numbers:
124+
125+
![Example with line numbers](https://imgur.com/Jqiydf8.png)
121126

122127
## Customisation
123128

0 commit comments

Comments
 (0)