go-hibp/README.md

15 lines
979 B
Markdown
Raw Permalink Normal View History

2021-09-21 11:21:04 +02:00
# go-hibp - Simple go client for the HIBP API
[![Go Reference](https://pkg.go.dev/badge/github.com/wneessen/go-hibp.svg)](https://pkg.go.dev/github.com/wneessen/go-hibp) [![Go Report Card](https://goreportcard.com/badge/github.com/wneessen/go-hibp)](https://goreportcard.com/report/github.com/wneessen/go-hibp) [![Build Status](https://api.cirrus-ci.com/github/wneessen/go-hibp.svg)](https://cirrus-ci.com/github/wneessen/go-hibp)
2021-09-21 20:42:06 +02:00
This Go package provides an simple to use interface to the excellent
"[Have I Been Pwned](https://haveibeenpwned.com/API/v3)" (HIBP) API by Troy Hunt.
2021-09-21 11:21:04 +02:00
2021-09-21 20:42:06 +02:00
**Completeness:** This packages is still WIP. So far the "Pwned Passwords" API and parts of the "Breaches"
API have been implemented.
2021-09-21 11:21:04 +02:00
2021-09-21 20:42:06 +02:00
## Usage
Have a look at the [GoDocs Reference](https://pkg.go.dev/github.com/wneessen/go-hibp) for details on how to implement
access to the HIBP API with this package or check out the examples for the different APIs in the [examples](examples)
directory.