diff --git a/README.md b/README.md index 0c7cdfd..2e5d7be 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # Golang Library for HashiCorp vault +[![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](https://pkg.go.dev/github.com/mittwald/vaultgo) +[![Release](https://img.shields.io/github/release/mittwald/vaultgo.svg?style=flat-square)](https://github.com/mittwald/vaultgo/releases/latest) +![Go](https://github.com/mittwald/vaultgo/workflows/Compile%20&%20Test/badge.svg?branch=master) + This is yet another golang vault client. It uses the [official vault go client](https://github.com/hashicorp/vault/tree/master/api) but adds some requests and responses types and some convenient methods for an improved Developing experience. @@ -21,17 +25,19 @@ Token-based and Kubernetes Auth are supported as of now. Initialize a new Vault Client using your token and endpoint: -[Example](https://pkg.go.dev/github.com/mittwald/vaultgo#example-TokenBased) +[Example](https://pkg.go.dev/github.com/mittwald/vaultgo#example-package-TokenBased) ### Kubernetes In-Cluster Example -[Example](https://pkg.go.dev/github.com/mittwald/vaultgo#example-K8sInCluster) +[Example](https://pkg.go.dev/github.com/mittwald/vaultgo#example-package-K8sInCluster) ## Usage Once the Vault Client is created, instanciate new clients for each engine: -[TransitList Example](https://pkg.go.dev/github.com/mittwald/vaultgo#Transit.List) +[TransitList Example](https://pkg.go.dev/github.com/mittwald/vaultgo#example-Transit.List) + +[Transit Encrypt/Decrypt Example](https://pkg.go.dev/github.com/mittwald/vaultgo#example-package-EncryptDecryptType) ### Run Tests