diff --git a/README.md b/README.md index c94f853..9d57000 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,11 @@ [![codecov](https://codecov.io/gh/wneessen/go-hibp/branch/main/graph/badge.svg?token=ST96EC0JHU)](https://codecov.io/gh/wneessen/go-hibp) buy ma a coffee -This Go library provides simple and idiomatic bindings to the excellent +This Go library provides simple bindings to the excellent "[Have I Been Pwned](https://haveibeenpwned.com/API/v3)" (HIBP) API by Troy Hunt. It implements all 3 APIs that are provided by HIBP (Breaches, Pastes, Passwords). API key support for the private API endpoints are -supported as well. +supported as well. go-hibp follows idiomatic Go style and best practice. It's only dependency is the Go Standard +Library. ## Usage The library is fully documented using the execellent GoDoc functionality. Check out the