updating docs back into v0
This commit is contained in:
parent
5975b5ed5c
commit
b96f17fb19
8
.idea/.gitignore
vendored
Normal file
8
.idea/.gitignore
vendored
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# Default ignored files
|
||||||
|
/shelf/
|
||||||
|
/workspace.xml
|
||||||
|
# Editor-based HTTP Client requests
|
||||||
|
/httpRequests/
|
||||||
|
# Datasource local storage ignored files
|
||||||
|
/dataSources/
|
||||||
|
/dataSources.local.xml
|
7
.idea/discord.xml
Normal file
7
.idea/discord.xml
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="DiscordProjectSettings">
|
||||||
|
<option name="show" value="PROJECT" />
|
||||||
|
<option name="description" value="" />
|
||||||
|
</component>
|
||||||
|
</project>
|
9
.idea/gosecret.iml
Normal file
9
.idea/gosecret.iml
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<module type="WEB_MODULE" version="4">
|
||||||
|
<component name="Go" enabled="true" />
|
||||||
|
<component name="NewModuleRootManager">
|
||||||
|
<content url="file://$MODULE_DIR$" />
|
||||||
|
<orderEntry type="inheritedJdk" />
|
||||||
|
<orderEntry type="sourceFolder" forTests="false" />
|
||||||
|
</component>
|
||||||
|
</module>
|
8
.idea/modules.xml
Normal file
8
.idea/modules.xml
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="ProjectModuleManager">
|
||||||
|
<modules>
|
||||||
|
<module fileurl="file://$PROJECT_DIR$/.idea/gosecret.iml" filepath="$PROJECT_DIR$/.idea/gosecret.iml" />
|
||||||
|
</modules>
|
||||||
|
</component>
|
||||||
|
</project>
|
6
.idea/vcs.xml
Normal file
6
.idea/vcs.xml
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="VcsDirectoryMappings">
|
||||||
|
<mapping directory="$PROJECT_DIR$" vcs="Git" />
|
||||||
|
</component>
|
||||||
|
</project>
|
@ -14,6 +14,8 @@ Last updated {localdatetime}
|
|||||||
:toclevels: 7
|
:toclevels: 7
|
||||||
:source-highlighter: rouge
|
:source-highlighter: rouge
|
||||||
|
|
||||||
|
image::https://pkg.go.dev/badge/r00t2.io/gosecret.svg[link="https://pkg.go.dev/r00t2.io/gosecret"]
|
||||||
|
|
||||||
This project is originally forked from https://github.com/gsterjov/go-libsecret[go-libsecret^] due to:
|
This project is originally forked from https://github.com/gsterjov/go-libsecret[go-libsecret^] due to:
|
||||||
|
|
||||||
* Lack of response from the developer
|
* Lack of response from the developer
|
||||||
@ -32,7 +34,7 @@ To use this library as a replacement without significantly modifying your code,
|
|||||||
.go.mod
|
.go.mod
|
||||||
[source]
|
[source]
|
||||||
----
|
----
|
||||||
# ...
|
// ...
|
||||||
replace (
|
replace (
|
||||||
github.com/gsterjov/go-libsecret dev => r00t2.io/gosecret v0
|
github.com/gsterjov/go-libsecret dev => r00t2.io/gosecret v0
|
||||||
)
|
)
|
||||||
|
45
doc.go
Normal file
45
doc.go
Normal file
@ -0,0 +1,45 @@
|
|||||||
|
// See LICENSE in source root directory for copyright and licensing information.
|
||||||
|
|
||||||
|
/*
|
||||||
|
Package libsecret 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 libsecret
|
Loading…
Reference in New Issue
Block a user