Skip to content

Commit

Permalink
add badges, fix godoc links (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
hensur authored Oct 9, 2020
1 parent d29df71 commit 8f0c73e
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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

Expand Down

0 comments on commit 8f0c73e

Please sign in to comment.