From 7ee2fbbd5ef36cec5c985801d2bc39829b025d9c Mon Sep 17 00:00:00 2001 From: Georg Hopp Date: Thu, 26 Jan 2017 14:39:04 +0100 Subject: [PATCH] some more info in README.md --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8b1cf72..596f456 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,21 @@ really wanted my credentials stored in a way that I can access them without clicking to some kind of GUI. Also these tools don't use a GUI they rely on an running X server instance -because password values are copied into the X clipboard via xclip. For -more dependencies look under [DEPENDENCIES](#DEPENDENCIES). +because password values are copied into the X clipboard via +[xclip](https://github.com/astrand/xclip). The data will be encrypted with +[GnuPG](https://www.gnupg.org/) using my private key. Usually my credentials +for that key are already cached within a running **gpg-agent** instance. +The storage backend is an [SQLite](https://www.sqlite.org/) (>= 3.6.19) +database. The default database file to use can be set with the +**AMNGRDB** environment variable and the GnuPG recipient should be set +in the **AMNGRID** environment variable. (See [OPTIONS](#options)) + +After downloading this either via git clone or as an archive just do +a *make install*. This will install all files under the */usr* **PREFIX**. +If you want to install somewhere else just do +*PREFIX=/path/to/go make install*. + +For usage see [DESCRIPTION](#description). ## NAME