Skip to content

Commit

Permalink
README: expand the ToC and add Acknowledgments section
Browse files Browse the repository at this point in the history
  • Loading branch information
chrissimpkins committed Dec 17, 2023
1 parent 1bb39ac commit 2b45939
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,17 @@ Project tests run in the latest macOS, Windows, and Ubuntu Linux GitHub Actions
## Contents

- [Features](#features)
- [Default](#default)
- [Optional](#optional)
- [Quickstart](#quickstart)
- [Installation](#installation)
- [Minimum supported Rust version (MSRV)](#minimum-supported-rust-version-msrv)
- [Cargo install (crates.io)](#cargo-install-cratesio)
- [Cargo install (source repository)](#cargo-install-source-repository)
- [Usage](#usage)
- [Changes](#changes)
- [License](#license)
- [Acknowledgments](#acknowledgments)

## Features

Expand Down Expand Up @@ -65,7 +72,7 @@ The minimum supported Rust version is 1.70.0.
Install a Rust toolchain on your system, and then use the cargo package manager to install the `siz` executable from the crates.io distribution with:

```
$ cargo install siz
cargo install siz
```

### Cargo install (source repository)
Expand Down Expand Up @@ -94,4 +101,8 @@ Please see [CHANGELOG.md](CHANGELOG.md).

## License

[Apache License, v2.0](LICENSE)
[Apache License, v2.0](LICENSE)

## Acknowledgments

This project uses the fantastic [ignore crate](https://github.com/BurntSushi/ripgrep/tree/master/crates/ignore) for recursive file system traversal. This library allows us to support a set of filtered path traversal defaults, command line filtering options, and ignore configuration file support that will feel familiar to users of `ripgrep` and other projects that use this library. A huge thanks goes out to the ignore project authors for this great resource.

0 comments on commit 2b45939

Please sign in to comment.