You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ There are two ways to use `clog`, as a binary via the command line or as a libra
23
23
24
24
### Binary (Command Line)
25
25
26
-
In order to use `clog` via the command line you must first obtain a binary by either compiling it yourself, or downlading and installing one of the precompiled binaries.
26
+
In order to use `clog` via the command line you must first obtain a binary by either compiling it yourself, or downloading and installing one of the precompiled binaries.
27
27
28
28
#### `cargo install`
29
29
@@ -87,7 +87,7 @@ Otherwise, ensure you have the `clog` binary in the directory which you operatin
87
87
88
88
#### Using clog from the Command Line
89
89
90
-
`clog` works by reading your `git` metadata and specially crafted commit messages and subjects to create a changelog. `clog` has the following options availble.
90
+
`clog` works by reading your `git` metadata and specially crafted commit messages and subjects to create a changelog. `clog` has the following options available.
91
91
92
92
```sh
93
93
USAGE:
@@ -104,7 +104,7 @@ FLAGS:
104
104
OPTIONS:
105
105
-C, --changelog <changelog> A previous changelog to prepend new changes to (this is like
106
106
using the same file for both --infile and --outfile and
107
-
should not be used inconjuction with either)
107
+
should not be used inconjunction with either)
108
108
-c, --config <config> The Clog Configuration TOML file to use (Defaults to
109
109
'.clog.toml')**
110
110
-T, --format <format> The output format, defaults to markdown
@@ -175,7 +175,7 @@ subtitle = "my awesome title"
175
175
link-style = "github"
176
176
177
177
# The preferred way to set a constant changelog. This file will be read for old changelog
178
-
# data, then prepended to for new changelog data. It's the equivilant to setting
178
+
# data, then prepended to for new changelog data. It's the equivalent to setting
179
179
# both infile and outfile to the same file.
180
180
#
181
181
# Do not use with outfile or infile fields!
@@ -223,7 +223,7 @@ MySection = ["mysec", "ms"]
223
223
224
224
Now if you make a commit message such as `mysec(Component): some message` or `ms(Component): some message` there will be a new "MySection" section along side the "Features" and "Bug Fixes" areas.
225
225
226
-
*NOTE:* Sections with spaces are suppported, such as `"My Special Section" = ["ms", "mysec"]`
226
+
*NOTE:* Sections with spaces are supported, such as `"My Special Section" = ["ms", "mysec"]`
0 commit comments