-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Clarify project purpose in README * Update godoc link to point to v2 version. * Add more sub-sections explaining project purpose. * Add sub-sections for installation and usage. Closes #12
- Loading branch information
Showing
1 changed file
with
21 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,21 @@ | ||
[![Coverage](https://gocover.io/_badge/github.com/rsjethani/secret)](https://gocover.io/github.com/rsjethani/secret) [![GoDoc reference example](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/rsjethani/secret) | ||
# secret - Prevent your secrets from leaking into logs and std* | ||
The package provides the type `Secret` for storing passwords and credentials. Using this type allows the actual secret string to be automatically redacted from printing and marshaling processes. See Go docs for example usage. | ||
[![Coverage](https://gocover.io/_badge/github.com/rsjethani/secret)](https://gocover.io/github.com/rsjethani/secret) [![GoDoc reference example](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/rsjethani/secret/v2) | ||
# secret v2 | ||
|
||
### What secret is? | ||
- It provides simple Go types like [secret.Text](https://pkg.go.dev/github.com/rsjethani/secret/v2#Text) to encapsulate your secret. | ||
- The encapsulated secret remains inaccessible to operations like printing, logging, and JSON serializtion, a redact hint like `*****` is returned instead. | ||
- The only way to access the actual secret value is by asking explicitly via the `.Value()` method. | ||
|
||
### What secret is not? | ||
- It is not a secret management service or your local password manager. | ||
- It is not a Go client to facilitate communication with secret managers like Hashicorp Vault, AWS secret Manager etc. Checkout [teller](https://github.com/spectralops/teller) if that is what you are looking for. | ||
|
||
### Installation | ||
``` | ||
go get github.com/rsjethani/secret/v2 | ||
``` | ||
NOTE: v1 is deprectated now. | ||
|
||
### Usage | ||
See godoc reference for usage examples. | ||
|