Add README

README.md

@@ -0,0 +1,36 @@
+# pass2keepass
+
+Load a Password Store into a KeePass database.
+
+This script is intended to synchronize a KeePass database with a Password Store.
+The KeePass will be dropped at replaced with a new database holding the contents of the Password Store.
+
+## Getting started
+
+```sh
+$ ./pass2keepass.py -v path_to_database.kdbx
+```
+
+The Password Store is found at `$PASSWORD_STORE_DIR` if set, otherwise defaults to `~/.password-store`.
+
+```sh
+$ PASSWORD_STORE_DIR=/some/other/path ./pass2keepass.py -v path_to_database.kdbx
+```
+
+## Requirements
+
+The script uses `gnupg` to decrypt the Pass entries and `pykeepass` to manage the KeePass database.
+To install these python libs:
+
+- Using `pip` in a virtual environment:
+```sh
+pip install -r requirements.txt
+```
+- On Archlinux:
+```sh
+pacman -S python-gnupg python-pykeepass
+```
+- On Debian:
+```sh
+apt install python3-gnupg python3-pykeepass
+```