Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DonIsaac committed Apr 23, 2024
1 parent 80c08c0 commit 19ebdf0
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,30 @@
# KeyHunter
[![CI Check](https://github.com/DonIsaac/keyhunter/actions/workflows/pipeline.yml/badge.svg)](https://github.com/DonIsaac/keyhunter/actions/workflows/pipeline.yml)

Check for leaked API keys and secrets on public websites
Check for leaked API keys and secrets on public websites.

## Installation
You can install KeyHunter as a Crate from crates.io:
```sh
cargo install keyhunter --all-features
```

You can also use it as a library:
```toml
[dependencies]
keyhunter = "0.1.0"
```

## Usage
Provide KeyHunter with a URL to start scanning from. It will visit all pages
on the same domain that URL links to, find all scripts referenced by those
pages, and check them for leaked API keys and secrets.

```sh
keyhunter https://example.com
```

Run `keyhunter --help` for more information.

## Disclamer

Expand Down

0 comments on commit 19ebdf0

Please sign in to comment.