Add Quickstart

sschmid · Oct 8, 2024 · 1b12fe2 · 1b12fe2
1 parent d412a86
commit 1b12fe2
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -83,6 +83,25 @@ Legend:
 | YubiKey support                                                                 | ❌             | ✅                                   | ❌             |
 | Automatic keychain discovery                                                    | ✅             | ✅                                   | ✅             |
 
+# Quickstart
+
+```bash
+# create a keychain
+pw init ~/secrets.keychain-db
+
+# configure keychains in ~/.pwrc
+echo 'PW_KEYCHAINS=(~/secrets.keychain-db)' > ~/.pwrc
+
+# add an entry
+pw add GitHub sschmid
+
+# copy the password
+pw GitHub
+
+# print the password using fzf
+pw -p
+```
+
 # Usage
 
 In all following examples, `[<args>]` refers to the optional