diff --git a/.idea/.gitignore b/.idea/.gitignore
new file mode 100644
index 0000000..13566b8
--- /dev/null
+++ b/.idea/.gitignore
@@ -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
diff --git a/.idea/discord.xml b/.idea/discord.xml
new file mode 100644
index 0000000..8cf359d
--- /dev/null
+++ b/.idea/discord.xml
@@ -0,0 +1,7 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.idea/gosecret.iml b/.idea/gosecret.iml
new file mode 100644
index 0000000..5e764c4
--- /dev/null
+++ b/.idea/gosecret.iml
@@ -0,0 +1,9 @@
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.idea/modules.xml b/.idea/modules.xml
new file mode 100644
index 0000000..7afe57b
--- /dev/null
+++ b/.idea/modules.xml
@@ -0,0 +1,8 @@
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
new file mode 100644
index 0000000..94a25f7
--- /dev/null
+++ b/.idea/vcs.xml
@@ -0,0 +1,6 @@
+
+
+
+
+
+
\ No newline at end of file
diff --git a/README.adoc b/README.adoc
index 8e5d42b..c21e9ce 100644
--- a/README.adoc
+++ b/README.adoc
@@ -14,6 +14,8 @@ Last updated {localdatetime}
:toclevels: 7
: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:
* Lack of response from the developer
@@ -32,7 +34,7 @@ To use this library as a replacement without significantly modifying your code,
.go.mod
[source]
----
-# ...
+// ...
replace (
github.com/gsterjov/go-libsecret dev => r00t2.io/gosecret v0
)
@@ -48,7 +50,7 @@ To use the new version,
[source,go]
----
import (
- `r00t2.io/gosecret/v1`
+ `r00t2.io/gosecret/v1`
)
----
diff --git a/doc.go b/doc.go
new file mode 100644
index 0000000..a554e04
--- /dev/null
+++ b/doc.go
@@ -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