Moving Message Tokens to their own header

Author: Sertion

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Change Log
 
-## 2.3.0 (March 24, 2018) [WIP]
+## 2.3.1 (March 24, 2018)
+
+* Fix: Updating Readme
+
+## 2.3.0 (March 24, 2018)
 
 * Feature: Atempting to auto detect if you use a known git web interface [#15](https://github.com/Sertion/vscode-gitblame/issues/15) (Thanks to [@Fidge123](https://github.com/Fidge123), [@sabrehagen](https://github.com/sabrehagen), [@henvic](https://github.com/henvic), and an extra thanks to [@neerolyte](https://github.com/neerolyte))
 * Feature: Added `gitblame.statusBarPositionPriority` for moving the status bar view [#25](https://github.com/Sertion/vscode-gitblame/issues/25) (Thanks to [@jvoigt](https://github.com/jvoigt))

README.md

@@ -29,29 +29,10 @@ See Git Blame information in the status bar for the currently selected line.
   - use the git blame `-w` flag
 - `gitblame.infoMessageFormat` (`string`, default `"${commit.hash} ${commit.summary}"`)
   - message that appears when the `gitblame.quickInfo` command executes (when you click the status bar message)
-  - available tokens:
-    - `${commit.hash}` - 40-bit hash unique to the commit
-    - `${commit.hash_short,length}` - the first `length` characters of the 40-bit hash unique to the commit, defaults to `7` first characters
-    - `${commit.summary}` - the first line of the commit message
-    - `${commit.filename}` - the file name where the line was committed
-    - `${author.name}` - the commit author's name
-    - `${author.email}` - the commit author's e-mail
-    - `${author.timestamp}` - timestamp for the commit author's commit
-    - `${author.tz}` - the commit author's time zone
-    - `${committer.name}` - the committer's name
-    - `${committer.email}` - the committer's e-mail
-    - `${committer.timestamp}` - timestamp for the committer's commit
-    - `${committer.tz}` - the committer's time zone
-    - `${time.ago}` - displays an estimation of how long ago the author committed (e.g. `10 hours ago`, `20 days ago`, `4 months ago`)
-    - `${time.custom,your_format}` - custom time format based on [momentjs.format(your_format)](https://momentjs.com/docs/#/displaying/format/) (uses author timestamp)
-    - `${time.from}` - format based on [momentjs.fromNow()](https://momentjs.com/docs/#/displaying/fromnow/) (uses author timestamp)
-    - `${time.c_ago}` - displays an estimation of how long ago the committer committed (e.g. `10 hours ago`, `20 days ago`, `4 months ago`)
-    - `${time.c_custom,your_format}` - custom time format based on [momentjs.format(your_format)](https://momentjs.com/docs/#/displaying/format/) (uses committer timestamp)
-    - `${time.c_from}` - format based on [momentjs.fromNow()](https://momentjs.com/docs/#/displaying/fromnow/) (uses committer timestamp)
+  - [available tokens](#message-tokens)
 - `gitblame.statusBarMessageFormat` (`string`, default `"Blame ${author.name} ( ${time.ago} )"`)
   - message in the status bar about the current line's git blame commit
-  - available tokens:
-    - See `gitblame.infoMessageFormat`
+  - [available tokens](#message-tokens)
 - `gitblame.statusBarMessageNoCommit` (`string`, default `"Not Committed Yet"`)
   - message in the status bar about the current line when no commit can be found
   - available tokens:
@@ -63,19 +44,37 @@ See Git Blame information in the status bar for the currently selected line.
   - an array of strings that will be displayed in sequence to denote progress while blaming files in larger repositories
   - supports [Octoicons](https://octicons.github.com/) with the `~spin` suffix for spin action
   - when the array only contains one item that item is rendered once instead of every 100ms
-  - Some suggested values:
-    - `["－", "／", "｜", "＼"]`
-    - `["⣾", "⣽", "⣻", "⢿", "⡿", "⣟", "⣯", "⣷"]`
-    - `["[Loading ]", "[oading L]", "[ading Lo]", "[ding Loa]", "[ing Load]", "[ng Loadi]", "[g Loadin]", "[ Loading]"]`
-    - `["🕐", "🕑", "🕒", "🕓", "🕔", "🕕", "🕖", "🕗", "🕘", "🕙", "🕚", "🕛"]`
 - `gitblame.logLevel` (`array` of `string`, default `["info", "error", "command", "critical"]`)
   - an array of levels to log to the extension log
   - available levels:
-    - `"info"`,
-    - `"error"`,
-    - `"command"`,
+    - `"info"`
+    - `"error"`
+    - `"command"`
     - `"critical"`
 
+## Message Tokens
+
+| Token | Function | Parameter | Default Value | Description |
+|-------|----------|-----------|---------------|-------------|
+| `${commit.hash}` | No | - | - | 40-bit hash unique to the commit |
+| `${commit.hash_short,length}` | Yes | `length` | 7 | the first `length` characters of the 40-bit hash unique to the commit |
+| `${commit.summary}` | No | - | - | the first line of the commit message |
+| `${commit.filename}` | No | - | - | the file name where the line was committed |
+| `${author.name}` | No | - | - | the commit author's name |
+| `${author.email}` | No | - | - | the commit author's e-mail |
+| `${author.timestamp}` | No | - | - | timestamp for the commit author's commit |
+| `${author.tz}` | No | - | - | the commit author's time zone |
+| `${committer.name}` | No | - | - | the committer's name |
+| `${committer.email}` | No | - | - | the committer's e-mail |
+| `${committer.timestamp}` | No | - | - | timestamp for the committer's commit |
+| `${committer.tz}` | No | - | - | the committer's time zone |
+| `${time.ago}` | No | - | - | displays an estimation of how long ago the author committed (e.g. `10 hours ago`, `20 days ago`, `4 months ago`) |
+| `${time.custom,format}` | Yes | `format` | `undefined` | custom time format based on [momentjs.format(format)](https://momentjs.com/docs/#/displaying/format/) (uses author timestamp) |
+| `${time.from}` | No | - | - | format based on [momentjs.fromNow()](https://momentjs.com/docs/#/displaying/fromnow/) (uses author timestamp) |
+| `${time.c_ago}` | No | - | - | displays an estimation of how long ago the committer committed (e.g. `10 hours ago`, `20 days ago`, `4 months ago`) |
+| `${time.c_custom,format}` | No | `format` | `undefined` | custom time format based on [momentjs.format(format)](https://momentjs.com/docs/#/displaying/format/) (uses committer timestamp) |
+| `${time.c_from}` | No | - | - | format based on [momentjs.fromNow()](https://momentjs.com/docs/#/displaying/fromnow/) (uses committer timestamp) |
+
 # [Planned Features](https://github.com/Sertion/vscode-gitblame/labels/Planned)
 
 # [Known Issues](https://github.com/Sertion/vscode-gitblame/issues)