Update readme

CHANGELOG.md

@@ -4,6 +4,7 @@
 - restore pane processes
 - user option for disabling pane process restoring
 - enable whitelisting processes that will be restored
+- expand readme with configuration options
 
 ### v0.0.4, 2014-08-26
 - restore pane layout for each window

README.md

@@ -1,15 +1,35 @@
 # Tmux Session Saver
 
-Enables saving and restoring of tmux sessions.
+Persists `tmux` environment across system restarts.
 
-Requirements / dependencies:
+Tmux is great, except when you have to restart your computer. You loose all the
-- `tmux 1.9` or higher
+running programs, working directories, pane layouts etc.
-- `pgrep`
+There are helpful management tools out there, but they require initial
+configuration and continuous updates as your workflow evolves or you start new
+projects.
+
+Enter `tmux-session-saver`: tmux persistence without configuration so there are
+no interruptions in your workflow.
+
+### About
+
+This plugin goes to great lengths to save and restore all the details from your
+`tmux` environment. Here's what's been taken care of:
+
+- all sessions, windows, panes and their order
+- current working directory for each pane
+- **exact panes layout** within a window
+- active and alternative session
+- active and alternative window for each session
+- active pane for each window
+- programs running within a pane! More details in the [configuration section](#configuration).
+
+Requirements / dependencies: `tmux 1.9` or higher, `pgrep`
 
 ### Key bindings
 
-- `prefix + M-s` - save
+- `prefix + Alt-s` - save
-- `prefix + M-r` - restore
+- `prefix + Alt-r` - restore
 
 ### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
 
@@ -40,5 +60,35 @@ Reload TMUX environment:
 
 You should now be able to use the plugin.
 
+### Configuration
+
+By default, only a conservative list of programs is restored:
+`vim emacs man less more tail top htop irssi`.
+Open a github issue if you think some other program should be on the default list.
+
+- Restore additional programs by putting the following in `.tmux.conf`:
+
+        set -g @session-saver-processes 'ssh telnet myprogram'
+
+- Don't restore any programs:
+
+        set -g @session-saver-processes 'false'
+
+- Restore **all** programs (be careful with this!):
+
+        set -g @session-saver-processes ':all:'
+
+### Reporting bugs and contributing
+
+Code contributions are welcome!
+
+If you find a bug please report it in the issues. When reporting a bug please
+attach a file that is symlinked to `~/.tmux/sessions/last`.
+
+### Credits
+
+[Mislav Marohnic](https://github.com/mislav) - the idea for the plugin came from his
+[tmux-session script](https://github.com/mislav/dotfiles/blob/master/bin/tmux-session).
+
 ### License
 [MIT](LICENSE.md)