diff options
| author | Guangxiong Lin <[email protected]> | 2022-10-26 16:47:09 +0800 |
|---|---|---|
| committer | Guangxiong Lin <[email protected]> | 2022-10-26 16:47:09 +0800 |
| commit | 1132aa57102d41926b80173b2df211582dceb00e (patch) | |
| tree | 4843310f349cc43f868efdb8190ded322283b01e | |
| parent | d7db7be02df08e25627b9e8712c7143d2ccdf393 (diff) | |
| download | pass-login-1132aa57102d41926b80173b2df211582dceb00e.tar.gz pass-login-1132aa57102d41926b80173b2df211582dceb00e.tar.bz2 pass-login-1132aa57102d41926b80173b2df211582dceb00e.zip | |
Add READMEv0.1.1
| -rw-r--r-- | README.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..4088c73 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# pass-login + +A [pass](https://www.passwordstore.org/) extension for extracting usernames. + +The extension looks for the following fields by order: +- The second column in any line beginning with `login:`, `Login:`, + `Username:`, `username:`. +- The path of the pass file. + +## Usage + +``` +Usage: + pass login [--clip,-c] pass-name + Show existing username and optionally put it on the clipboard. + If put on the clipboard, it will be cleared in 45 seconds. + pass help + Show this text. + +More information may be found in the pass-login(1) man page. +``` + +## Installation + +### Manually + +```bash +git clone https://github.com/igxlin/pass-login.git +cd pass-login +sudo make install +``` + +### macOS + +Homebrew: + +```bash +brew tap igxlin/tap +brew install pass-login +``` |