Skip to content

Commit cce1cf2

Browse files
karlhorkyAlexTMjugador
authored andcommitted
Fix name capitalization
1 parent ef64dd0 commit cce1cf2

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ Oxipng is known to be packaged for the environments listed below.
2424

2525
[![Packaging status](https://repology.org/badge/vertical-allrepos/oxipng.svg?exclude_unsupported=1&columns=3&exclude_sources=modules,site)](https://repology.org/project/oxipng/versions)
2626

27-
Alternatively, oxipng can be installed from Cargo, via the following command:
27+
Alternatively, Oxipng can be installed from Cargo, via the following command:
2828

2929
```
3030
cargo install oxipng
3131
```
3232

3333
Oxipng can also be built from source using the latest stable or nightly Rust.
34-
This is primarily useful for developing on oxipng.
34+
This is primarily useful for developing on Oxipng.
3535

3636
```
3737
git clone https://github.com/shssoichiro/oxipng.git
@@ -95,9 +95,9 @@ repos:
9595
9696
## Git integration via [Trunk]
9797
98-
[Trunk] is an extendable superlinter which can be used to run `oxipng` to automatically optimize `png`s when committing them into a git repo, or to gate any `png`s being added to a git repo on whether they are optimized. The [trunk] oxipng integration is [here](https://github.com/trunk-io/plugins/tree/main/linters/oxipng).
98+
[Trunk] is an extendable superlinter which can be used to run `oxipng` to automatically optimize `png`s when committing them into a git repo, or to gate any `png`s being added to a git repo on whether they are optimized. The [trunk] Oxipng integration is [here](https://github.com/trunk-io/plugins/tree/main/linters/oxipng).
9999

100-
To enable oxipng via [trunk]:
100+
To enable Oxipng via [trunk]:
101101

102102
```bash
103103
# to get the latest version:
@@ -145,16 +145,16 @@ docker run --rm -v $(pwd):/work ghcr.io/shssoichiro/oxipng -o 4 /work/file.png
145145

146146
## Library Usage
147147

148-
Although originally intended to be used as an executable, oxipng can also be used as a library in
149-
other Rust projects. To do so, simply add oxipng as a dependency in your Cargo.toml,
148+
Although originally intended to be used as an executable, Oxipng can also be used as a library in
149+
other Rust projects. To do so, simply add Oxipng as a dependency in your Cargo.toml,
150150
then `extern crate oxipng` in your project. You should then have access to all of the library
151151
functions [documented here](https://docs.rs/oxipng). The simplest
152152
method of usage involves creating an
153153
[Options struct](https://docs.rs/oxipng/latest/oxipng/struct.Options.html) and
154154
passing it, along with an input filename, into the
155155
[optimize function](https://docs.rs/oxipng/latest/oxipng/fn.optimize.html).
156156

157-
It is recommended to disable the "binary" feature when including oxipng as a library. Currently, there is
157+
It is recommended to disable the "binary" feature when including Oxipng as a library. Currently, there is
158158
no simple way to just disable one feature in Cargo, it has to be done by disabling default features
159159
and specifying the desired ones, for example:
160160
`oxipng = { version = "9.0", features = ["parallel", "zopfli", "filetime"], default-features = false }`
@@ -187,7 +187,7 @@ Oxipng is open-source software, distributed under the MIT license.
187187

188188
## Benchmarks
189189

190-
Tested OxiPNG 9.0.0 (commit `c16519b38b0519988db625913be919d4f0e42f5d`, compiled
190+
Tested Oxipng 9.0.0 (commit `c16519b38b0519988db625913be919d4f0e42f5d`, compiled
191191
on `rustc 1.74.0-nightly (7b4d9e155 2023-09-28)`) against OptiPNG version 0.7.7,
192192
as packaged by Debian unstable, on a Linux 6.5.0-2-amd64 kernel, Intel Core
193193
i7-12700 CPU (8 performance cores, 4 efficiency cores, 20 threads), DDR5-5200
@@ -224,7 +224,7 @@ Summary
224224
<details>
225225
<summary>Older benchmark</summary>
226226
227-
Tested oxipng 5.0.0 (compiled on rustc 1.55.0-nightly (7a16cfcff 2021-07-11)) against OptiPNG version 0.7.7 on AMD Ryzen 7 4800H with Radeon Graphics with 16 logical cores
227+
Tested Oxipng 5.0.0 (compiled on rustc 1.55.0-nightly (7a16cfcff 2021-07-11)) against OptiPNG version 0.7.7 on AMD Ryzen 7 4800H with Radeon Graphics with 16 logical cores
228228
229229
```
230230

0 commit comments

Comments
 (0)