aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorGravatar Étienne Deparis 2017-02-06 19:24:58 +0100
committerGravatar Étienne Deparis 2018-08-09 19:03:46 +0200
commit666ee6ab40394fee37eaf243540b4b9c5a280b9e (patch)
treec6d0b51dd4b02902da0eaca8bcee468510619427
parentcad151ccb018242ef6434010474e0108949a77c7 (diff)
downloadpassword-store-666ee6ab40394fee37eaf243540b4b9c5a280b9e.tar.gz
password-store-666ee6ab40394fee37eaf243540b4b9c5a280b9e.tar.xz
password-store-666ee6ab40394fee37eaf243540b4b9c5a280b9e.zip
docs: Update readme
-rw-r--r--README30
-rw-r--r--README.org92
2 files changed, 92 insertions, 30 deletions
diff --git a/README b/README
deleted file mode 100644
index 6b59965..0000000
--- a/README
+++ /dev/null
@@ -1,30 +0,0 @@
-======================
-Simple Password Store
-by Jason Donenfeld
- Jason@zx2c4.com
-======================
-
-This is a very simple password store that encrypts passwords using gpg and
-places the encrypted password in a directory. It can generate new passwords
-and keep track of old ones.
-
-Visit the project page for more information: http://www.passwordstore.org/
-
-Please see the man page for documentation and examples.
-
-Depends on:
-- bash
- http://www.gnu.org/software/bash/
-- GnuPG2
- http://www.gnupg.org/
-- git
- http://www.git-scm.com/
-- xclip
- http://sourceforge.net/projects/xclip/
-- tree >= 1.7.0
- http://mama.indstate.edu/users/ice/tree/
-- GNU getopt
- http://www.kernel.org/pub/linux/utils/util-linux/
- http://software.frodo.looijaard.name/getopt/
-- qrencode
- https://fukuchi.org/works/qrencode/
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..d52cffb
--- /dev/null
+++ b/README.org
@@ -0,0 +1,92 @@
+#+title: Password Store
+#+options: toc:nil
+
+* About
+
+This is a very simple password store that encrypts passwords using gpg and
+places the encrypted password in a directory. It can generate new passwords
+and keep track of old ones.
+
+Visit the project page for more information: http://www.passwordstore.org/
+
+Please see the man page for documentation and examples.
+
+* Modification introduced by this fork
+
+** Add a flat output for search command
+
+The =-f= switch has been added to the =find= command to allow one to
+display a flat representation of the search results.
+
+#+begin_src
+$ pass find op frama
+Search Terms: op,frama
+├── internet
+│   ├── dropbox
+│   ├── framagit
+│   ├── framalistes
+│   ├── framasoft
+│   ├── myopel
+│   ├── openstreetmap
+│   └── opera
+├── moneyMoneyMoney
+│   └── creditCoop
+└── socialMedia
+ ├── framagora
+ └── framasphere
+#+end_src
+
+#+begin_src
+$ pass find -f op frama
+Search Terms: op,frama
+├── moneyMoneyMoney/creditCoop
+├── internet/framagit
+├── internet/opera
+├── internet/openstreetmap
+├── internet/framalistes
+├── internet/framasoft
+├── internet/dropbox
+├── internet/myopel
+├── socialMedia/framagora
+└── socialMedia/framasphere
+#+end_src
+
+** Add a fuzzy selector
+
+Selection of a password now work on any part of the password name.
+
+#+begin_src
+$ pass internet/framagit
+my very complex passw0rd
+$ pass framagit
+Found one matching item: internet/framagit
+my very complex passw0rd
+$ pass frama
+Search Terms: internet
+├── internet/framagit
+├── internet/framalistes
+├── internet/framasoft
+├── socialMedia/framagora
+└── socialMedia/framasphere
+#+end_src
+
+** Add rofi support
+
+I've added a little script in =contrib/rofi=, which works exactly as the
+passmenu script, but use [[https://davedavenport.github.io/rofi/][rofi]] as password selector.
+
+* Depandencies
+
+Depends on:
+- bash :: http://www.gnu.org/software/bash/
+- GnuPG2 :: http://www.gnupg.org/
+- git :: http://www.git-scm.com/
+- xclip :: http://sourceforge.net/projects/xclip/
+- tree :: >= 1.7.0 http://mama.indstate.edu/users/ice/tree/
+- GNU getopt :: http://www.kernel.org/pub/linux/utils/util-linux/
+ http://software.frodo.looijaard.name/getopt/
+- qrencode :: https://fukuchi.org/works/qrencode/
+
+* Credits
+
+Simple Password Store by Jason Donenfeld <Jason@zx2c4.com>