summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMichael Allen <michael@michaelallen.io>2015-08-25 15:38:58 +0100
committerMichael Allen <michael@michaelallen.io>2015-08-25 15:38:58 +0100
commit98e3ea67a2d7fec429ca1532f6e64bc78923b814 (patch)
treec8f049f13fa1744db18353fbb740f46ac28f907f /README.md
parent6c3c7f65c9497b603736ba32ba30571fcf1e9839 (diff)
downloadgit-sonar-98e3ea67a2d7fec429ca1532f6e64bc78923b814.tar.gz
git-sonar-98e3ea67a2d7fec429ca1532f6e64bc78923b814.zip
Fix the table formatting
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 13 insertions, 15 deletions
diff --git a/README.md b/README.md
index 090fea6..1c7e2a1 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,3 @@
----
-
# Git Radar
A heads up display for git.
@@ -14,17 +12,17 @@ Install from brew:
Then add to your prompt:
-*Bash*
+**Bash**
Add to your `.bashrc`
-```
+```bash
export PS1="$PS1$(git-radar --bash)"
```
-*Zsh*
+**Zsh**
Add to your `.zshrc`
-```
+```zsh
export PROMPT="$PROMPT$(git-radar --zsh) "
```
@@ -36,7 +34,7 @@ The prompt lists the file changes and whether they are staged, unstaged or
untracked.
Prompt | Meaning
-------------------------------------
+---------------------------|--------
![git:(master) 3A] | We have 3 untracked files
![git:(master) 2D2M] | We have 2 modifications and 2 deletions not yet staged to commit
![git:(master) 1M1R] | We have 1 modification and a file renamed staged and ready to commit
@@ -47,7 +45,7 @@ Each symbol represents a different change to a file. These are based on what git
considers has happened to the file.
Symbol | Meaning
------------------
+--------|--------
A | A new Added file
D | A file has been Deleted
M | A file has been Modified
@@ -60,7 +58,7 @@ B | A conflict caused by Both us and them
The color tells you what stage the change is at.
Color | Meaning
------------------
+--------|--------
Green | Staged and ready to be committed (i.e. you have done a `git add`)
Red | Unstaged, you'll need to `git add` them before you can commit
Grey | Untracked, these are new files git is unaware of
@@ -73,7 +71,7 @@ remote your branch is tracking. The examples below assume you are checked out on
`master` and are tracking `origin/master`.
Prompt | Meaning
------------------------------
+--------------------|--------
![git:(master 2↑)] | We have 2 commits to push up
![git:(master 3↓)] | We have 3 commits to pull down
![git:(master 3⇵5)] | Our version and origins version of `master` have diverged
@@ -87,7 +85,7 @@ configurable in the future.
This is the difference between the commits you've pushed up and `origin/master`.
Prompt | Meaning
--------------------------------------------
+---------------------------|---------------
![git:(m ← 2 my-branch)] | We have 2 commits on `origin/my-branch` that aren't on `origin/master`
![git:(m 4 → my-branch)] | There are 4 commits on `origin/master` that aren't on `origin/my-branch`
![git:(m 1 ⇄ 2 my-branch)] | `origin/master` and `origin/my-branch` have diverged, we'll need to rebase or merge
@@ -103,13 +101,13 @@ repo you are currently in.
To use this feature, when setting your prompt, call git-radar with `--fetch`:
-*Bash*
-```
+**Bash**
+```bash
export PS1="$PS1$(git-radar --bash --fetch)"
```
-*Zsh*
-```
+**Zsh**
+```zsh
export PROMPT="$PROMPT$(git-radar --zsh --fetch) "
```