summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md57
1 files changed, 41 insertions, 16 deletions
diff --git a/README.md b/README.md
index c445b62c..f811169e 100644
--- a/README.md
+++ b/README.md
@@ -71,20 +71,25 @@ configuration is the default:
The segments that are currently available are:
* [aws](#aws) - The current AWS profile, if active.
+* [battery](#battery) - Current battery status.
* [context](#context) - Your username and host.
* [dir](#dir) - Your current working directory.
+* **go_version** - Show the current GO version.
* **history** - The command number for the current line.
* [ip](#ip) - Shows the current IP address.
-* **load** - Your machines 5 minute load average and free RAM.
+* **load** - Your machines 5 minute load average.
* **node_version** - Show the version number of the installed Node.js.
+* **nvm** - Show the version of Node that is currently active, if it differs from the version used by NVM
* **os_icon** - Display a nice little icon, depending on your operating system.
* **php_version** - Show the current PHP version.
+* [ram](#ram) - Show free RAM and used Swap.
* [rbenv](#rbenv) - Ruby environment information (if one is active).
* [rspec_stats](#rspec_stats) - Show a ratio of test classes vs code classes for RSpec.
* [status](#status) - The return code of the previous command, and status of background jobs.
* [symphony2_tests](#symphony2_tests) - Show a ratio of test classes vs code classes for Symfony2.
* **symphony2_version** - Show the current Symfony2 version, if you are in a Symfony2-Project dir.
* [time](#time) - System time.
+* [todo](http://todotxt.com/) - Shows the number of tasks in your todo.txt tasks file.
* [vi_mode](#vi_mode)- Vi editing mode (NORMAL|INSERT).
* **virtualenv** - Your Python [VirtualEnv](https://virtualenv.pypa.io/en/latest/).
* [vcs](#vcs) - Information about this `git` or `hg` repository (if you are in one).
@@ -99,6 +104,23 @@ your `~/.zshrc`:
export AWS_DEFAULT_PROFILE=<profile_name>
+##### battery
+
+This segment will display your current battery status (fails gracefully
+on systems without a battery). It can be customized in your .zshrc
+with the environment variables detailed below with their default values.
+
+ POWERLEVEL9K_BATTERY_CHARGING="yellow"
+ POWERLEVEL9K_BATTERY_CHARGED="green"
+ POWERLEVEL9K_BATTERY_DISCONNECTED=$DEFAULT_COLOR
+ POWERLEVEL9K_BATTERY_LOW_THRESHOLD=10
+ POWERLEVEL9K_BATTERY_LOW_COLOR="red"
+
+In addition to the above it supports standard _FOREGROUND value without affecting the icon color
+
+Supports both OS X and Linux(time remaining requires the acpi program on Linux)
+
+
##### context
The `context` segment (user@host string) is conditional. This lets you enable it, but only display
@@ -152,6 +174,15 @@ following variable in your `~/.zshrc`.
POWERLEVEL9K_STATUS_VERBOSE=false
+##### ram
+
+By default this segment shows you free RAM and used Swap. If you want to show
+only one value, you can specify `POWERLEVEL9K_RAM_ELEMENTS` and set it to either
+`ram_free` or `swap_used`. Full example:
+
+ # Show only used swap:
+ POWERLEVEL9K_RAM_ELEMENTS=(swap_used)
+
##### symphony2_tests
See [Unit Test Ratios](#unit-test-ratios), below.
@@ -213,23 +244,17 @@ from the [Installation](#Installation) section above.
##### vi_mode
-This Segment shows the current mode of your ZSH. If you want to use your ZSH in
-VI-Mode, you need to configure it separately in your `~/.zshrc`:
-
- # VI-Mode
- # general activation
- bindkey -v
+This segment shows ZSH's current input mode. Note that this is only useful if
+you are using the [ZSH Line Editor](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html)
+(VI mode). You can enable this either by `.zshrc` configuration or using a plugin, like
+[Oh-My-Zsh's vi-mode plugin](https://github.com/robbyrussell/oh-my-zsh/blob/master/plugins/vi-mode/vi-mode.plugin.zsh).
- # set some nice hotkeys
- bindkey '^P' up-history
- bindkey '^N' down-history
- bindkey '^?' backward-delete-char
- bindkey '^h' backward-delete-char
- bindkey '^w' backward-kill-word
- bindkey '^r' history-incremental-search-backward
+If you want to display a string other than "NORMAL" or "INSERT" in `command` and
+`insert-mode`, you can do so by setting the following variables in your
+`~/.zshrc`:
- # make it more responsive
- export KEYTIMEOUT=1
+ POWERLEVEL9K_VI_INSERT_MODE_STRING="INSERT"
+ POWERLEVEL9K_VI_COMMAND_MODE_STRING="NORMAL"
#### Unit Test Ratios