Skip to content

Commit

Permalink
docs: update from just to braisé
Browse files Browse the repository at this point in the history
  • Loading branch information
cestef committed Jul 8, 2024
1 parent b657931 commit 99a1bff
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ cargo install rwalk

The full documentation can be found at **[https://rwalk.cstef.dev](https://rwalk.cstef.dev)**.

## Task Runner

This project uses [`braisé`](https://github.com/cestef/braise) as a task runner. You can find all the available tasks in the [`braise.toml`](braise.toml) file.

## Benchmarks

The following benchmarks were run on a 2023 MacBook Pro with an M3 Pro chip on a 10 Gbps connection via WiFi. The target was [http://ffuf.me/cd/basic](http://ffuf.me/cd/basic) and the wordlist was [common.txt](https://github.com/danielmiessler/SecLists/blob/master/Discovery/Web-Content/common.txt).
Expand All @@ -61,13 +65,13 @@ Each tool was run `10` times with `100` threads. The results are below:
If you want to run the benchmarks yourself, you can use the `bench` command:

```bash
just bench
br bench
```

Positional arguments can also be passed.
Arguments can also be passed to the `bench` command:

```bash
just bench <URL> <WORDLIST_FILE> <THREADS>
URL="http://ffuf.me/cd/basic" br bench
```

Please take these results with a grain of salt.
Expand Down

0 comments on commit 99a1bff

Please sign in to comment.