Documentation.

This commit is contained in:
Greg 2019-11-26 13:31:21 -05:00
parent 94cfbbeb41
commit 4d6a8fd86a

View File

@ -4,8 +4,9 @@ This repository includes Go code to interact with pass, the Unix password
manager. Library code is provided to open a password store, list
saved passwords, and decrypt specified passwords. The library provides
a simple passphrase input function, or, if gpg-agent is running (on MacOS),
it will connect automatically to request your GPG passphrase. MacOS users
can also ask passgo to copy a password directly to the clipboard.
it will connect automatically to request your GPG passphrase. On Android,
`passgo` connects to OpenKeychain. MacOS and Android users can also ask passgo
to copy a password directly to the clipboard.
```go
store := passgo.Store{}
@ -29,5 +30,5 @@ p, err := store.Decrypt("myPass")
...
```
Also included is a simple GUI front-end using [Gio](https://gioui.org). See
`cmd/passgo-gui`.
Also included is a simple GUI front-end using [Gio](https://gioui.org)
that works on MacOS and Android. See `cmd/passgo-gui`.