From 8ddcd7a13d1f8e5129e3f08c929b46f92af20729 Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Sun, 22 Apr 2012 15:19:37 +0100 Subject: [PATCH] Update readme, again --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0382672..dcd96f0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# tmuxifier +# Tmuxifier Tmuxify your Tmux. Create, edit and load complex Tmux session, window and pane configurations with ease. @@ -16,8 +16,10 @@ like. You will need to be very familiar with a few of Tmux's commands however. ## Example -Given with have a window layout file called `example.window.sh` which looks -like: +Given we have a window layout file called [example.window.sh][example] which +looks like: + +[example]: https://github.com/jimeh/tmuxifier/blob/master/examples/example.window.sh ```bash window_name "Example Window" @@ -62,6 +64,12 @@ export TMUXIFIER="$HOME/.dotfiles/tmuxifier" [[ -s "$TMUXIFIER/init.sh" ]] && source "$TMUXIFIER/init.sh" ``` +## Heed My Warning + +Tmuxifier is pretty much an alpha product at this point. Documentation is +sketchy at best, and things might drastically change further down the line. If +that doesn't put you off, enjoy Tmuxifier :) + ## License Released under the MIT license. Copyright (c) 2012 Jim Myhrberg.