Updates README

README.md

@@ -6,134 +6,94 @@
   align="right"
 />
 
-This a fork of the
+Bullet Train is a [oh-my-zsh shell](https://github.com/robbyrussell/oh-my-zsh)
-[Powerline Vim plugin](https://github.com/Lokaltog/vim-powerline) for the
+theme based on the 
-[oh-my-zsh shell](https://github.com/robbyrussell/oh-my-zsh).
+[Powerline Vim plugin](https://github.com/Lokaltog/vim-powerline). It aims for 
+simplicity, showing information only when it's relevant.
 
 It currently shows:
 - Current Python virtualenv
-- Current git repo
+- Current Ruby version and gemset, through RVM
-- Status of the current git repo
+- Git status
-- Time
+- Timestamp
+- Current directory
 
 If you want add some new feature, of fix some bug, open an issue and lets hack
 together.
 
-Currently a **work in progress**.
-
 
 ## Preview
 
-![Preview](http://raw.github.com/caiogondim/bullet-train-oh-my-zsh-theme/master/preview.png)
+![Preview](http://raw.github.com/caiogondim/bullet-train-oh-my-zsh-theme/master/img/preview.gif)
 
 
-## Set Up
+## Requirements
 
-1. Clone the repository.
+In order to use the theme, you will first need:
 
-2. Create a symlink of **powerline.zsh-theme** in **.oh-my-zsh/themes/**. You can use the **install_in_omz.sh** file:
+* [Vim Powerline patched](https://github.com/Lokaltog/powerline-fonts)
+* [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh)
+* Make sure terminal is using 256-colors mode with `export TERM="xterm-256color"`
 
-    ```
-    ./install_in_omz.sh
-    ```
 
-3. Configure the theme in your **.zshrc** file:
+## Installing
 
-    ```
+1. Download the theme here
+
+2. Put the file **bullet-train.zsh-theme** in **~/.oh-my-zsh/themes/**
+
+3. Configure the theme in your **~/.zshrc** file:
+```bash
 ZSH_THEME="powerline"
 ```
 
 
-## More options
+## Options
 
-All options must be overridden in your **.zshrc** file.
+Bullet Train is configurable. You can change colors and which segments you want
+or don't want to see. All options must be overridden in your **.zshrc** file.
 
-By default, at the right of the powerline are displayed the date and the time.
+The status segment backgound and foreground color
-If you don't want date or time, you can choose what you want to display:
+```bash
-
+BULLETTRAIN_STATUS_BG=black
-```
+BULLETTRAIN_STATUS_FG=default
-BULLETTRAIN_RIGHT_B="date replacement"
 ```
 
-Or if you don't want to display anything:
+The time segment background and foreground color
-
+```bash
-```
+BULLETTRAIN_TIME_BG=green
-BULLETTRAIN_RIGHT_B="none"
+BULLETTRAIN_TIME_FG=white
 ```
 
-If you want to display date next to time:
+Python virtualenv background and foreground color, and the symbol used for the
-```
+segment
-BULLETTRAIN_RIGHT_A="date"
+```bash
+BULLETRTAIN_VIRTUALENV_BG=yellow
+BULLETRTAIN_VIRTUALENV_FG=white
+BULLETRTAIN_VIRTUALENV_SYMBOL=🐍
 ```
 
-If you want to display exit-code of last command next to time:
+RMV backgound and foreground color, and the symbol used for the segment
-```
+```bash
-BULLETTRAIN_RIGHT_A="exit-status"
+BULLETTRAIN_RVM_BG=magenta
+BULLETTRAIN_RVM_FG=white
+BULLETTRAIN_RVM_SYMBOL=♦️
 ```
 
-If you want to display date or non-zero-exit-code of last command next to time:
+Current directory background and foreground colors
-```
+```bash
-BULLETTRAIN_RIGHT_A="mixed"
+BULLETTRAIN_DIR_BG=blue
+BULLETTRAIN_DIR_FG=white
 ```
 
-If you want to display a custom text next to time:
+GIT background and foreground colors
-```
+```bash
-BULLETTRAIN_RIGHT_A="Your very best text"
+BULLETTRAIN_GIT_BG=white
+BULLETTRAIN_GIT_FG=black
 ```
 
-If you want to change the date format to what you want:
+GIT icons info
-```
+```bash
-BULLETTRAIN_DATE_FORMAT="%D{%d-%m}"
-```
-
-If you don't want to display your username (the green or red (root) colors are still there):
-
-```
-BULLETTRAIN_HIDE_USER_NAME="true"
-```
-
-If you don't want to display your hostname (the green or red (root) colors are still there):
-
-```
-BULLETTRAIN_HIDE_HOST_NAME="true"
-```
-
-If you want to hide git prompt status (new files, modified files, unmerged files, etc):
-```
-BULLETTRAIN_HIDE_GIT_PROMPT_STATUS="true"
-```
-
-If you want to hide the right hand side prompt completely:
-```
-BULLETTRAIN_DISABLE_RPROMPT="true"
-```
-
-If you don't want the blank line before the prompt:
-
-```
-BULLETTRAIN_NO_BLANK_LINE="true"
-```
-
-If you want full path:
-
-```
-BULLETTRAIN_FULL_CURRENT_PATH="true"
-```
-
-If you want git info on right instead of left:
-
-```
-BULLETTRAIN_SHOW_GIT_ON_RIGHT="true"
-```
-
-If you want to tell if you are in a remote SSH session:
-
-```
-BULLETTRAIN_DETECT_SSH="true"
-```
-
-Also you can change the icons of GIT info, default values are:
-```
 BULLETTRAIN_GIT_CLEAN="✔"
 BULLETTRAIN_GIT_DIRTY="✘"
 BULLETTRAIN_GIT_ADDED="%F{green}✚%F{black}"
@@ -145,30 +105,32 @@ BULLETTRAIN_GIT_UNMERGED="═"
 ```
 
 
-## Requirements
+## Credits
 
-* Vim Powerline patched font: Download your favorite one on [Lokaltog/powerline-font](https://github.com/Lokaltog/powerline-fonts).
+This theme is highly inspired by the following themes:
-* Z shell (zsh): See [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) for more info.
+- [Powerline](https://github.com/jeremyFreeAgent/oh-my-zsh-powerline-theme)
-* Make sure terminal is using 256-colors mode with `export TERM="xterm-256color"`.
+- [Agnoster](https://gist.github.com/agnoster/3712874)
 
 
-## Contribute
+## License
+The MIT License (MIT)
 
-### How to contribute
+Copyright (c) 2014 [Caio Gondim](http://caiogondim.com)
 
-* Create an issue if you find a bug or if you want a new feature.
+Permission is hereby granted, free of charge, to any person obtaining a copy
-* Fork the project and pull request your very best feature.
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-### Thanks
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-* [shouze](https://github.com/shouze)
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-* [stephpy](https://github.com/stephpy)
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-* [Ph3nol](https://github.com/Ph3nol)
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-* [gbin](https://github.com/gbin)
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-* [krischer](https://github.com/krischer)
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-* [Arthraim](https://github.com/Arthraim)
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-* [itszero](https://github.com/itszero)
+SOFTWARE.
-* [adrienbrault](https://github.com/adrienbrault)
-* [mkraemer](https://github.com/mkraemer)
-* [wujtruj](https://github.com/wujtruj)
-* [Flavius Aspra](http://flavius.github.com/)