Skip to content

Commit 7d0b76b

Browse files
committed
doc: update readme with new usage, change links of binary downloads
1 parent 4a4eec4 commit 7d0b76b

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@
2828
```
2929
Usage: toc [options]
3030
Options:
31-
-p, --path <path> Path for the markdown file.
32-
-a, --append Append toc after <!--toc-->, or write to stdout.
33-
-b, --bulleted Write as bulleted, or write as numbered list.
34-
-s, --skip Skip the first given number of headers.
35-
-d, --depth Set the number of maximum heading level to be included.
31+
-p, --path <path> Path for the markdown file. [REQUIRED]
32+
-a, --append <bool> Append toc after <!--toc-->, or write to stdout. [Default: true]
33+
-b, --bulleted <bool> Write as bulleted, or write as numbered list. [Default: true]
34+
-s, --skip <int> Skip the first given number of headers. [Default: 0]
35+
-d, --depth <int> Set the number of maximum heading level to be included. [Default: 6]
3636
-h, --help Show this message and exit.
3737
```
3838

@@ -88,12 +88,12 @@ Binary downloads of example are available from [the releases section on GitHub](
8888

8989
| platform |
9090
| ----------- |
91-
| [macOS 64 Bit](https://github.com/ycd/toc/releases/download/v2.0.0/toc_2.0.0_darwin_x86_64.tar.gz)
92-
| [Linux 32-Bit](https://github.com/ycd/toc/releases/download/v2.0.0/toc_2.0.0_linux_i386.tar.gz)
93-
| [Linux ARM 64 Bit](https://github.com/ycd/toc/releases/download/v2.0.0/toc_2.0.0_linux_arm64.tar.gz)
94-
| [Linux 64 Bit](https://github.com/ycd/toc/releases/download/v2.0.0/toc_2.0.0_linux_x86_64.tar.gz)
95-
| [Windows 64 Bit](https://github.com/ycd/toc/releases/download/v2.0.0/toc_2.0.0_windows_x86_64.zip)
96-
| [Windows 32 Bit](https://github.com/ycd/toc/releases/download/v2.0.0/toc_2.0.0_windows_i386.zip)
91+
| [macOS 64 Bit](https://github.com/ycd/toc/releases/download/v0.2.0/toc_0.2.0_darwin_x86_64.tar.gz)
92+
| [Linux 32-Bit](https://github.com/ycd/toc/releases/download/v0.2.0/toc_0.2.0_linux_i386.tar.gz)
93+
| [Linux ARM 64 Bit](https://github.com/ycd/toc/releases/download/v0.2.0/toc_0.2.0_linux_arm64.tar.gz)
94+
| [Linux 64 Bit](https://github.com/ycd/toc/releases/download/v0.2.0/toc_0.2.0_linux_x86_64.tar.gz)
95+
| [Windows 64 Bit](https://github.com/ycd/toc/releases/download/v0.2.0/toc_0.2.0_windows_x86_64.zip)
96+
| [Windows 32 Bit](https://github.com/ycd/toc/releases/download/v0.2.0/toc_0.2.0_windows_i386.zip)
9797

9898

9999

@@ -130,11 +130,11 @@ Binary downloads of example are available from [the releases section on GitHub](
130130
131131
Usage: toc [options]
132132
Options:
133-
-p, --path <path> Path for the markdown file.
134-
-a, --append Append toc after <!--toc-->, or write to stdout.
135-
-b, --bulleted Write as bulleted, or write as numbered list.
136-
-s, --skip Skip the first given number of headers.
137-
-d, --depth Set the number of maximum heading level to be included.
133+
-p, --path <path> Path for the markdown file. [REQUIRED]
134+
-a, --append <bool> Append toc after <!--toc-->, or write to stdout. [Default: true]
135+
-b, --bulleted <bool> Write as bulleted, or write as numbered list. [Default: true]
136+
-s, --skip <int> Skip the first given number of headers. [Default: 0]
137+
-d, --depth <int> Set the number of maximum heading level to be included. [Default: 6]
138138
-h, --help Show this message and exit.
139139
```
140140
---

0 commit comments

Comments
 (0)