Skip to content

Commit

Permalink
Merge pull request #69 from zalando/doc/bsd
Browse files Browse the repository at this point in the history
add to the readme that we also support *BSD
  • Loading branch information
mikkeloscar authored Feb 23, 2022
2 parents 0ab3fca + 4c8655e commit 3a474d1
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![GoDoc](https://godoc.org/github.com/zalando/go-keyring?status.svg)](https://godoc.org/github.com/zalando/go-keyring)

`go-keyring` is an OS-agnostic library for *setting*, *getting* and *deleting*
secrets from the system keyring. It supports **OS X**, **Linux (dbus)** and
secrets from the system keyring. It supports **OS X**, **Linux/BSD (dbus)** and
**Windows**.

go-keyring was created after its authors searched for, but couldn't find, a better alternative. It aims to simplify
Expand All @@ -25,9 +25,9 @@ keyring instead of having the user type it on every invocation.
The OS X implementation depends on the `/usr/bin/security` binary for
interfacing with the OS X keychain. It should be available by default.

#### Linux
#### Linux and *BSD

The Linux implementation depends on the [Secret Service][SecretService] dbus
The Linux and *BSD implementation depends on the [Secret Service][SecretService] dbus
interface, which is provided by [GNOME Keyring](https://wiki.gnome.org/Projects/GnomeKeyring).

It's expected that the default collection `login` exists in the keyring, because
Expand Down Expand Up @@ -82,8 +82,8 @@ Running the tests is simple:
go test
```

Which OS you use *does* matter. If you're using **Linux**, it will
test the implementation in `keyring_linux.go`. If running the tests
Which OS you use *does* matter. If you're using **Linux** or **BSD**, it will
test the implementation in `keyring_unix.go`. If running the tests
on **OS X**, it will test the implementation in `keyring_darwin.go`.

### Mocking
Expand Down

0 comments on commit 3a474d1

Please # to comment.