fix(readme): improve description and documentation

seantrane · seantrane · commit 37c0d4058de8 · 2019-02-09T09:18:18.000-05:00
diff --git a/README.md b/README.md
@@ -10,7 +10,9 @@
 
 **TL;DR:** _Want [beautiful GitHub Labels like these](https://github.com/seantrane/github-label-presets/labels)?_ Want to have them unobtrusively synced with your repos? Want to persist them indefinitely? Want to maintain your own labels? If the answers have been yes, this is definitely not _too long_, please read on.
 
-**TL;DR:2** Really? Still _too long_? Run; `npm install -g github-label-sync && github-label-sync -a <github_token> -l 'https://git.io/fAe5i' <github_name>/<github_repo>`
+1. Run; `npm install -g github-label-sync`
+2. Provide env-vars; `GITHUB_ACCESS_TOKEN`, `GITHUB_NAME`, `REPO`
+3. Run; `github-label-sync -l 'https://git.io/fAe5i' ${GITHUB_NAME}/${REPO}`
 
 ### Details
 
@@ -21,6 +23,8 @@ The default GitHub Labels are, well... not ideal. This has been described many t
 
 There are many very good examples of GitHub Label strategies. Almost all of them are an improvement over the default. But for several reasons or another few, in practice, none of them have felt truly great or sustainable.
 
+#### Principles
+
 `@seantrane/github-label-presets` were designed according to the following thoughts and principles:
 
 - GitHub Labels are used for both Issues and Pull Requests (PR), therefore the label context should be agnostic.
@@ -37,11 +41,19 @@ There are many very good examples of GitHub Label strategies. Almost all of them
   - `work` = describe situation; `chaotic`, `complex`, `complicated` or `obvious`
 - The only labels without prefixes are; `breaking`, `good first issue`, `greenkeeper`, `help` and `semantic-release`
 
-The _GitHub Label presets_ are meant to be used with [github-label-sync](https://github.com/Financial-Times/github-label-sync):
+#### Label Groups
+
+| Standard | Effort | Priority | State | Type | Work |
+| -------- | ------ | -------- | ----- | ---- | ---- |
+| Standard labels commonly used in most repositories. | Describes the relative effort to complete an issue or pull request. | Priority labels, but focused on describing the immediacy of attention required. | Describes the _decision_ state of the issue or pull request. | Describes the _type_ of issue or pull request. | Describes the kind of work involved in resolving the issue, using the [Cynefin framework](https://en.wikipedia.org/wiki/Cynefin_framework). |
+| ![Standard Labels](https://github.com/seantrane/github-label-presets/raw/master/docs/images/github-labels-standard.png) | ![Effort Labels](https://github.com/seantrane/github-label-presets/raw/master/docs/images/github-labels-effort.png) | ![Priority Labels](https://github.com/seantrane/github-label-presets/raw/master/docs/images/github-labels-priority.png) | ![State Labels](https://github.com/seantrane/github-label-presets/raw/master/docs/images/github-labels-state.png) | ![Type Labels](https://github.com/seantrane/github-label-presets/raw/master/docs/images/github-labels-type.png) | ![Work Labels](https://github.com/seantrane/github-label-presets/raw/master/docs/images/github-labels-work.png) |
+
+#### How It Works
 
-- _Synchronise your GitHub labels with as few destructive operations as possible - similar labels get renamed._
-- Load [label config](https://github.com/Financial-Times/github-label-sync#label-json) via path or URL.
-- Run on specified repo via CLI parameter.
+- [`github-label-sync`](https://github.com/Financial-Times/github-label-sync) is used to _synchronize your GitHub labels with as few destructive operations as possible - similar labels get renamed_.
+- The [label config](https://github.com/Financial-Times/github-label-sync#label-json) is loaded via path or URL, or more specifically; the config file supplied by [`@seantrane/github-label-presets`](https://github.com/seantrane/github-label-presets).
+- The `github-label-sync -l 'https://git.io/fAe5i' ${GITHUB_NAME}/${REPO}` command is run to have the label config applied to _your_ `profile/repo`.
+- The command can be run anywhere and anytime, but it's recommended during a CI plan. This will automatically keep your labels clean and synchronized with your chosen configuration - depending on how often your plan is run, of course.
 
 ## Usage <a id="usage"></a>
 
@@ -74,11 +86,11 @@ You can provide your own `labels.json` via the `[ -l, --lables ]` argument.
 
 ## Contribute <a id="contribute"></a>
 
-Contributions are always appreciated. Read [CONTRIBUTING.md](https://github.com/seantrane/balanced-theme-for-atom/blob/master/CONTRIBUTING.md) documentation to learn more.
+Contributions are always appreciated. Read [CONTRIBUTING.md](https://github.com/seantrane/github-label-presets/blob/master/CONTRIBUTING.md) documentation to learn more.
 
 ## Changelog <a id="changelog"></a>
 
-Release details are documented in the [CHANGELOG.md](https://github.com/seantrane/balanced-theme-for-atom/blob/master/CHANGELOG.md) file, and on the [GitHub Releases page](https://github.com/seantrane/balanced-theme-for-atom/releases).
+Release details are documented in the [CHANGELOG.md](https://github.com/seantrane/github-label-presets/blob/master/CHANGELOG.md) file, and on the [GitHub Releases page](https://github.com/seantrane/github-label-presets/releases).
 
 ---
 
