aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Hilburn <bhilburn@gmail.com>2015-03-30 04:32:30 +0300
committerBen Hilburn <bhilburn@gmail.com>2015-03-30 04:32:30 +0300
commit49d503f2e6ae423b9ac28e23aaa83279b8e1428b (patch)
tree2bcf57aac75ea9f326d785336cc19dddc3c2a9da /README.md
parent576f1c0309fe3232af5b8fac78405f954e452a99 (diff)
Segments now alphabetical in README. Broke out `aws` docs.
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.md b/README.md
index 531accd1..fcbff8e2 100644
--- a/README.md
+++ b/README.md
@@ -58,14 +58,14 @@ You then need to select this theme in your `~/.zshrc`:
You can choose which segments are shown on each side. The segments that are
currently available are:
+* **aws** - The current AWS profile, if active.
* **context** - Your username and host.
* **dir** - Your current working directory.
-* **vcs** - Information about this `git` or `hg` repository (if you are in one).
+* **history** - The command number for the current line.
* **rbenv** - Ruby environment information (if one is active).
* **status** - The return code of the previous command, and status of background jobs.
-* **history** - The command number for the current line.
-* **aws** - The current AWS profile, if you exported it with `export AWS_DEFAULT_PROFILE=<profile_name>`
* **time** - System time.
+* **vcs** - Information about this `git` or `hg` repository (if you are in one).
To specify which segments you want, just add the following variables to your
`~/.zshrc`. If you don't customize this, the below configuration is the default:
@@ -89,6 +89,15 @@ elements (it is by default), and define a `DEFAULT_USER` in your `~/.zshrc`:
export DEFAULT_USER=<your username>
+#### AWS Profile
+
+If you would like to display the [current AWS
+profile](http://docs.aws.amazon.com/cli/latest/userguide/installing.html), add
+the `aws` segment to one of the prompts, and define `AWS_DEFAULT_PROFILE` in
+your `~/.zshrc`:
+
+ export AWS_DEFAULT_PROFILE=<profile_name>
+
### Bugs / Contact
If you have any requests or bug reports, please use the tracker in this Github