Skip to content

Commit 8e58db2

Browse files
committed
docs: fix typos
1 parent b935f21 commit 8e58db2

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

.github/workflows/ci-pr.yml

+2
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ jobs:
6868

6969
- name: Check spelling
7070
uses: crate-ci/typos@master
71+
with:
72+
config: ./.typos.toml
7173

7274
- name: Install Rust
7375
uses: dtolnay/rust-toolchain@stable

.typos.toml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[type.md.extend-words]
2+
ba = "ba"
3+
afe = "afe"

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ There are two ways to use `clog`, as a binary via the command line or as a libra
2323

2424
### Binary (Command Line)
2525

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.
2727

2828
#### `cargo install`
2929

@@ -87,7 +87,7 @@ Otherwise, ensure you have the `clog` binary in the directory which you operatin
8787

8888
#### Using clog from the Command Line
8989

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.
9191

9292
```sh
9393
USAGE:
@@ -104,7 +104,7 @@ FLAGS:
104104
OPTIONS:
105105
-C, --changelog <changelog> A previous changelog to prepend new changes to (this is like
106106
using the same file for both --infile and --outfile and
107-
should not be used in conjuction with either)
107+
should not be used in conjunction with either)
108108
-c, --config <config> The Clog Configuration TOML file to use (Defaults to
109109
'.clog.toml')**
110110
-T, --format <format> The output format, defaults to markdown
@@ -175,7 +175,7 @@ subtitle = "my awesome title"
175175
link-style = "github"
176176
177177
# 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
179179
# both infile and outfile to the same file.
180180
#
181181
# Do not use with outfile or infile fields!
@@ -223,7 +223,7 @@ MySection = ["mysec", "ms"]
223223
224224
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.
225225
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"]`
227227
228228
## Companion Projects
229229

0 commit comments

Comments
 (0)