Skip to content

Commit

Permalink
docs: fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
kbknapp committed Jul 8, 2024
1 parent b94b579 commit 5d0762b
Show file tree
Hide file tree
Showing 5 changed files with 129 additions and 116 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/ci-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ jobs:

- name: Check spelling
uses: crate-ci/typos@master
with:
config: ./.typos.toml

- name: Install Rust
uses: dtolnay/rust-toolchain@stable
Expand Down
3 changes: 3 additions & 0 deletions .typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[type.md.extend-words]
ba = "ba"
afe = "afe"
150 changes: 76 additions & 74 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ There are two ways to use `clog`, as a binary via the command line or as a libra

### Binary (Command Line)

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

#### `cargo install`

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

#### Using clog from the Command Line

`clog` works by reading your `git` metadata and specially crafted commit messages and subjects to create a changelog. `clog` has the following options availble.
`clog` works by reading your `git` metadata and specially crafted commit messages and subjects to create a changelog. `clog` has the following options available.

```sh
USAGE:
Expand All @@ -104,7 +104,7 @@ FLAGS:
OPTIONS:
-C, --changelog <changelog> A previous changelog to prepend new changes to (this is like
using the same file for both --infile and --outfile and
should not be used in conjuction with either)
should not be used in conjunction with either)
-c, --config <config> The Clog Configuration TOML file to use (Defaults to
'.clog.toml')**
-T, --format <format> The output format, defaults to markdown
Expand Down Expand Up @@ -175,7 +175,7 @@ subtitle = "my awesome title"
link-style = "github"
# The preferred way to set a constant changelog. This file will be read for old changelog
# data, then prepended to for new changelog data. It's the equivilant to setting
# data, then prepended to for new changelog data. It's the equivalent to setting
# both infile and outfile to the same file.
#
# Do not use with outfile or infile fields!
Expand Down Expand Up @@ -223,7 +223,7 @@ MySection = ["mysec", "ms"]
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.
*NOTE:* Sections with spaces are suppported, such as `"My Special Section" = ["ms", "mysec"]`
*NOTE:* Sections with spaces are supported, such as `"My Special Section" = ["ms", "mysec"]`
## Companion Projects
Expand Down
Loading

0 comments on commit 5d0762b

Please sign in to comment.