46 lines
1.9 KiB
Go
46 lines
1.9 KiB
Go
|
// See LICENSE in source root directory for copyright and licensing information.
|
||
|
|
|
||
|
|
/*
|
||
|
|
Package gosecret is(/was originally) a fork of go-libsecret (see https://github.com/gsterjov/go-libsecret
|
||
|
|
and https://pkg.go.dev/github.com/gsterjov/go-libsecret).
|
||
|
|
|
||
|
|
It was forked in order to present bugfixes, actually document the library, conform to more Go-like patterns, and
|
||
|
|
provide missing functionality (as the original seems to be unmaintained).
|
||
|
|
As such, hopefully this library should serve as a more effective libsecret/SecretService interface.
|
||
|
|
|
||
|
|
Backwards Compatibility
|
||
|
|
|
||
|
|
Version series `v0.X.X` of this library promises full and non-breaking backwards compatibility/drop-in support of API interaction with the original project.
|
||
|
|
The only changes should be internal optimizations, adding documentation, some file reorganizing, adding Golang module support,
|
||
|
|
etc. -- all transparent from the library API itself.
|
||
|
|
|
||
|
|
To use this library as a replacement without significantly modifying your code, you can simply use a `replace` directive in your go.mod file:
|
||
|
|
|
||
|
|
// ...
|
||
|
|
replace (
|
||
|
|
github.com/gsterjov/go-libsecret dev => r00t2.io/gosecret v0
|
||
|
|
)
|
||
|
|
|
||
|
|
and then run `go mod tidy`.
|
||
|
|
|
||
|
|
Do NOT use the master branch. For anything. I make no promises on the stability of that branch at any given time.
|
||
|
|
New features will be added to V1 branch, and stable releases will be tagged. V0 branch is reserved only for optimization and bug fixes.
|
||
|
|
|
||
|
|
New Developer API
|
||
|
|
|
||
|
|
Starting from `v1.0.0` onwards, entirely breaking changes can be assumed from the original project.
|
||
|
|
To use the new version,
|
||
|
|
|
||
|
|
import (
|
||
|
|
`r00t2.io/gosecret/v1`
|
||
|
|
)
|
||
|
|
|
||
|
|
To reflect the absolute breaking changes, the module name changes as well from `libsecret` to `gosecret`.
|
||
|
|
|
||
|
|
Usage
|
||
|
|
|
||
|
|
Full documentation can be found via inline documentation.
|
||
|
|
Additionally, use either https://pkg.go.dev/r00t2.io/gosecret or https://pkg.go.dev/golang.org/x/tools/cmd/godoc (or `go doc`) in the source root.
|
||
|
|
*/
|
||
|
|
package gosecret
|