Skip to content
This repository has been archived by the owner on Oct 10, 2022. It is now read-only.

Added a few examples to the README #32

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,26 @@ If you get a lot of value out of this package, do consider donating to [HaveIbee

----

## Examples

If you want a list of the breaches where your email address has been included, use the `account_breaches()` function with `truncate = TRUE`.

`account_breaches("[email protected]", truncate = TRUE)`

The code is vectorized, so you can search more than one account at a time. Results are organized by email address.

`account_breaches(c("[email protected]","[email protected]"), truncate = TRUE)`

If you want more data, set `truncate` to `FALSE` or leave it out.

`account_breaches(c("[email protected]","[email protected]"))`

For additional information about a given breach, use `breached_site()` with the name you saw from `account_breaches()`.

`breached_site("Adobe")`

----

Wanna report a bug or suggest a feature? Great stuff! For more information on how to contribute check out [our contributing guide](.github/CONTRIBUTING.md).

Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.
Expand Down