Skip to content

Commit 383dba6

Browse files
committed
[docs] more docs
1 parent 446b067 commit 383dba6

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.org

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#+AUTHOR: yufu
33

44
* Why KeePass
5-
- I don't want to pay for password managers anymore. Especially most of them are subscription-based.
5+
- I don't want to pay for password managers anymore. Especially most of them are subscription-based. I argue that having a password manager is basic human right in 21st century, and it should be free and accessible to everybody.
66
- GNU Pass is good, but it's hard to interact with it outside of terminal.
77

88
* Why New CLI
@@ -15,18 +15,20 @@
1515
* Feature
1616
- List the entries with user-specified fields =keepass-cli -d <DATABSE> ls -f title username=
1717
- Server mode =keepass-cli -d <DATABASE> server --emacs=
18+
- Emacs integration uses pure =completing-read=, so you can use any completion engine you want.
1819

1920

20-
* Restriction
21+
* Restriction/Warning
2122
- It's read only! Please use official CLI to add/remove/edit entries/download icons.
23+
- It's only used/tested by me now.
2224

2325

2426
* Note
2527
The icon data is saved in the project directory, which is different between operating systems.
2628

2729
For example, on macOS, the directory is =~/Library/Application Support/keepass-cli=.
2830

29-
The directory path is generate by the following code from [[https://crates.io/crates/directories][directories]] crate. Please refer it to find your path.
31+
The directory path is generate by the following code from [[https://crates.io/crates/directories][directories]] crate. Please refer to it to find your path.
3032
#+begin_src rust
3133
ProjectDirs::from("", "", "keepass-cli")
3234
#+end_src
@@ -55,6 +57,8 @@ There are two functions: =keepass= and =keepass-inplace=.
5557
=keepass= will switch to a special buffer =keepass:main=.
5658
=keepass-inplace= will not.
5759

60+
Please refer to the source code to find what you can customize.
61+
5862
*** Screenshots for Emacs integration
5963
**** Interface
6064
[[./screenshots/keepass-inplace.png]]

0 commit comments

Comments
 (0)