summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDan Davison <dandavison7@gmail.com>2019-06-27 11:17:14 -0400
committerDan Davison <dandavison7@gmail.com>2019-06-27 11:17:14 -0400
commit2c3a9288a3e120246671ccac5348a0d2cbd92664 (patch)
tree5698b782ad8f770b4e71dda0c138e44839196633 /README.md
parent6a20a593f2fc07049afc3dcc1115431f77f3cd62 (diff)
Help text and README
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
index 52bc16ec..8411b374 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,33 @@
_(This project is at a very early stage, but please feel free to open issues.)_
+## Usage
+```
+delta 0.1.0
+Dan Davison <dandavison7@gmail.com>
+Adds language-specific syntax highlighting to git output. Use 'delta | less -R' as core.pager in .gitconfig
+
+USAGE:
+ delta [FLAGS] [OPTIONS]
+
+FLAGS:
+ --dark Use diff highlighting colors appropriate for a dark terminal background.
+ -h, --help Prints help information
+ --light Use diff highlighting colors appropriate for a light terminal background. This is the default.
+ -V, --version Prints version information
+
+OPTIONS:
+ --minus-color <minus_color> The background color (RGB hex) to use for removed lines. The default is "#ffd0d0"
+ if you are using --light, and "#3f0001" if you are using --dark.
+ --plus-color <plus_color> The background color (RGB hex) to use for added lines. The default is "#d0ffd0"
+ if you are using --light, and "#013B01" if you are using --dark.
+ --theme <theme> The syntax highlighting theme to use. Options are Light: ("InspiredGitHub",
+ "Solarized (light)", "base16-ocean.light"), Dark: ("Solarized, (dark)", "base16-
+ eighties.dark", "base16-mocha.dark", "base16-ocean.dark").
+ -w, --width <width> The width (in characters) of the diff highlighting. By default, the highlighting
+ extends to the last character on each line
+```
+
## Installation
#### 0. Use a terminal that supports 24 bit colors