Skip to content

Commit

Permalink
Update README for the v2 release
Browse files Browse the repository at this point in the history
  • Loading branch information
ericchiang committed Aug 17, 2024
1 parent 4259bca commit 43b5a93
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ This is not an officially supported Google product

# A Go YubiKey PIV implementation

[![GoDoc](https://godoc.org/github.com/go-piv/piv-go/piv?status.svg)](https://godoc.org/github.com/go-piv/piv-go/piv)
[![Go Reference](https://pkg.go.dev/badge/github.com/go-piv/piv-go/v2/piv.svg)](https://pkg.go.dev/github.com/go-piv/piv-go/v2/piv)

YubiKeys implement the PIV specification for managing smart card certificates.
This applet is a simpler alternative to GPG for managing asymmetric keys on a
Expand All @@ -15,6 +15,13 @@ a wrapper for YubiKey's ykpiv.h C library. This package aims to provide:
* Idiomatic Go APIs
* Modern features such as PIN protected management keys

V2 of this package was released in 2024 to support newer kinds of management
keys, and is now the default branch for new features. The import path is:

```
import "github.com/go-piv/piv-go/v2/piv"
```

## Examples

* [Signing](#signing)
Expand Down

0 comments on commit 43b5a93

Please sign in to comment.