diff --git a/CHANGELOG.md b/CHANGELOG.md index 4469033..26c3757 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ - make the directory where sessions are stored configurable - support only Tmux v1.9 or greater - display a nice error message if saved session file does not exist +- added README ### v0.0.1, 2014-08-26 - started a project diff --git a/README.md b/README.md index bdf2b8f..c7f806a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,40 @@ # Tmux Session Saver +Enables saving and restoring of tmux sessions. + +### Key bindings + +- `prefix + M-s` - save +- `prefix + M-r` - restore + +### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended) + +Add plugin to the list of TPM plugins in `.tmux.conf`: + + set -g @tpm_plugins " \ + tmux-plugins/tpm \ + tmux-plugins/tmux-session-saver \ + " + +Hit `prefix + I` to fetch the plugin and source it. You should now be able to +use the plugin. + +### Manual Installation + +Clone the repo: + + $ git clone https://github.com/tmux-plugins/tmux-session-saver ~/clone/path + +Add this line to the bottom of `.tmux.conf`: + + run-shell ~/clone/path/session_saver.tmux + +Reload TMUX environment: + + # type this in terminal + $ tmux source-file ~/.tmux.conf + +You should now be able to use the plugin. + ### License [MIT](LICENSE.md)