Add README for emacs wrapper

1 files changed, 59 insertions, 0 deletions

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..fccc177
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,59 @@
+dispass.el Emacs wrapper
+******************************************************************************
+
+dispass.el --- Generate and disperse/dispell passwords
+
+dispass.el is an emacs wrapper around dispass (http://dispass.babab.nl).
+
+Copyright (C) 2012 Tom Willemsen <tom@ryuslash.org>
+
+:Author: Tom Willemsen <tom@ryuslash.org>
+:Created: Jun 8, 2012
+:Version: 0.1a7.2
+:Keywords: encryption, security
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the
+above copyright notice and this permission notice appear in all
+copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
+CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
+Installation
+==============================================================================
+
+Place this file somewhere on your filesystem, either in your
+`load-path` or somewhere else which you will have to add to your
+`load-path`, like so::
+
+    (add-to-list 'load-path "/location/of/dispass.el")
+
+And then `load`, `require` or `autoload` it in your emacs init
+file, for example::
+
+    (require 'dispass)
+
+*Or* if you have package.el you could use `package-install-file`.
+
+Usage
+==============================================================================
+
+Using dispass.el is simple, once installed. Either call `dispass`
+to recall a priviously generated password or call `dispass-create`
+to generate a new password.
+
+The only real difference between the two is that `dispass-create`
+asks to confirm the password. Both will ask for a label.
+
+Once a password has been generated it is inserted into the kill
+ring and the system's clipboard so it can be easily inserted into
+password field, this makes the generated password easy to see in
+plaintext in the `kill-ring` variable, though.