diff --git a/README.md b/README.md index f844aa1..0cf2327 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,36 @@ # accountmanager.sh +## TOC + + - [ABOUT](#ABOUT) + - [NAME](#NAME) + - [SYNOPSIS](#SYNOPSIS) + - [DESCRIPTION](#DESCRIPTION) + - [OPTIONS](#OPTIONS) + - [ENVIRONMENT](#ENVIRONMENT) + - [DEPENDENCIES](#DEPENDENCIES) + - [SEE ALSO](#SEE-ALSO) + - [BUGS](#BUGS) + - [AUTHOR](#AUTHOR) + - [COPYRIGHT](#COPYRIGHT) + +## ABOUT + +This is a bunch of shell tools to maintain a list of credentials, +(username, password) tuples to multiple accounts, identidied by a unique +name, similar to [KeePass](http://keepass.info). + +I created this because I was unhappy with the existing solutions. I +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). + ## NAME -accountmanager.sh − source all functionality into the current shell +**accountmanager.sh** − source all functionality into the current shell General purpose functions: - **random** − create a non blocking stream of random data on stdout