Update README.md for v1.0.0 release #572

rkeithhill · 2018-05-06T03:20:54Z

Replaces PR #529

dahlbyk

I got through the first half. Will resume later.

Great work on these changes — we're close!

dahlbyk · 2018-05-06T16:15:59Z

README.md

-[![master build coverage](https://coveralls.io/repos/github/dahlbyk/posh-git/badge.svg?branch=master)](https://coveralls.io/github/dahlbyk/posh-git?branch=master)
-( [README](https://github.com/dahlbyk/posh-git/blob/master/README.md)
-• [CHANGELOG](https://github.com/dahlbyk/posh-git/blob/master/CHANGELOG.md) )
+| Windows (AppVeyor) | Linux/macOS (Travis | Code Coverage Status |


Missing ) on Travis.

dahlbyk · 2018-05-06T16:19:28Z

README.md

+| [![v0 build status][av-v0-img]][av-v0-site] | [![v0 build coverage][cc-v0-img]][cc-v0-site] |
+
+[README][v0-readme]
+• [CHANGELOG](https://github.com/dahlbyk/posh-git/blob/v0/CHANGELOG.md)


Should this be a link reference (or whatever they're called)?

dahlbyk · 2018-05-06T16:20:18Z

README.md

+| [![master build status][av-master-img]][av-master-site] | [![master build status][tv-master-img]][tv-master-site] | [![master build coverage][cc-master-img]][cc-master-site] |
+
+[README](https://github.com/dahlbyk/posh-git/blob/master/README.md)
+• [CHANGELOG](https://github.com/dahlbyk/posh-git/blob/master/CHANGELOG.md)


These, too. Probably search for (http in the doc to find others.

Will do but a few I'll leave inline - primarly bug fix links and any that has the link in the displayed text e.g. [https://git-scm.com](https://git-scm.com).

dahlbyk · 2018-05-06T16:24:24Z

README.md

-Import-PackageProvider NuGet -Force
-```
-Then retry the `Install-Module` command above.
+2. Execute one of the following two commands from an elevated PowerShell prompt depending on your current posh-git installation status:


, before depending?

dahlbyk · 2018-05-06T16:25:12Z

README.md

+   ```powershell
+   # If you have never installed posh-git from the PowerShell Gallery
+   # NOTE: If asked to trust packages from the PowerShell Gallery, answer yes to continue installation of posh-git
+   PowerShellGet\Install-Module posh-git -Scope CurrentUser -Force


Why -Force here?

To force side-by-side:

05-06 11:17:02 46ms 3> install-module posh-git -Scope CurrentUser -AllowPrerelease WARNING: Version '0.7.1' of module 'posh-git' is already installed at 'C:\Users\Keith\Documents\WindowsPowerShell\Modules\posh-git\0.7.1'. To install version '1.0.0-beta1', run Install-Module and add the -Force parameter, this command will install version '1.0.0-beta1' in side-by-side with version '0.7.1'. C:\Users\Keith 05-06 11:17:27 38ms 4> install-module posh-git -Scope CurrentUser -AllowPrerelease -Force C:\Users\Keith 05-06 11:17:41 42ms 5>

dahlbyk · 2018-05-06T16:26:31Z

README.md

+
+The version of `PSReadLine` (1.2) that ships with PowerShell Core 6.0 has known issues that cause problems with the
+prompt function that posh-git uses.  Fortunately, there is a beta of PSReadLine 2.0.0 that fixes these problems.
+You can check the version of PSReadLine you have by executing: `get-module psreadline`.


Should we add a warning to posh-git.psm1 if we detect this situation?

And super nitpicky, but maybe capitalize Get-Module PSReadline?

dahlbyk · 2018-05-06T16:28:05Z

README.md

+You can check the version of PSReadLine you have by executing: `get-module psreadline`.
+If it less than 2.0.0, follow this procedure.
+
+1. Start PowerShell Core by running `pwsh`.


They just checked version in pwsh; they don't need this step 1.

dahlbyk · 2018-05-06T16:29:13Z

README.md

 If you want posh-git to be available in just the current host, then execute `Add-PoshGitToProfile`.
 This will add the same command but to the file `$profile.CurrentUserCurrentHost`.

+If you want posh-git to be available for all users on the system, start PowerShell as Administrator or
+via sudo (sudo pwsh) on Linux/macOS then execute `Add-PoshGitToProfile -AllUsers -AllHosts`.


Format sudo as code?

rkeithhill · 2018-05-06T23:30:41Z

Sure would be nice to get beta2 out next week - if possible. :-)

dahlbyk · 2018-05-07T03:07:07Z

Trying…

dahlbyk

Revisions look good. Here's my feedback on the rest of the changes.

dahlbyk · 2018-05-07T03:14:42Z

README.md

-PowerShellGet\Install-Module posh-git -Scope CurrentUser
-```
-You may be asked if you trust packages coming from the PowerShell Gallery. Answer yes to allow installation of this module to proceed.
+posh-git is available on the [PowerShell Gallery][psgallery-beta1] and can be installed using the PowerShellGet module.


Thought I had commented on this before, but I guess not…

Let's name this link psgallery-v1 so we just need to update link once 1.0 final drops.

dahlbyk · 2018-05-07T03:16:14Z

README.md

+[choco-site]:      https://chocolatey.org/packages/poshgit/
+[psgallery-beta1]: https://www.powershellgallery.com/packages/posh-git/1.0.0-beta1
+[psgallery-img]:   https://img.shields.io/powershellgallery/dt/posh-git.svg
+[psgallery-site]:  https://powershellgallery.com/packages/posh-git


Canonical links for PS Gallery should include www

dahlbyk · 2018-05-07T03:22:32Z

README.md

- * `~` = There are uncommitted changes i.e. staged changes in the working tree waiting to be committed (`LocalStagedStatus`)
- * None = There are no unstaged or uncommitted changes to the working tree (`LocalDefault`)
-* `]` (`AfterText`)
+- `[` (`BeforeText`)


This is BeforeStatus as of #544.

dahlbyk · 2018-05-07T03:23:51Z

README.md

+    the remote branch (`BranchBehindAndAheadStatus`).  NOTE: this status is only available if
+    `$GitPromptSettings.BranchBehindAndAheadDisplay` is set to `Compact`.
+  - `×` = The local branch is tracking a branch that is gone from the remote (`BranchGoneStatus`)
+- `ABCD` represent the index; `|` (`DelimText`); `EFGH` represent the working directory


DelimStatus

dahlbyk · 2018-05-07T03:24:56Z

README.md

+  - `!` = There are unstaged changes in the working tree (`LocalWorkingStatus`)
+  - `~` = There are uncommitted changes i.e. staged changes in the working tree waiting to be committed (`LocalStagedStatus`)
+  - None = There are no unstaged or uncommitted changes to the working tree (`LocalDefault`)
+- `]` (`AfterText`)


AfterStatus

dahlbyk · 2018-05-07T03:30:57Z

README.md

+- `W` represents the overall status of the working directory
+  - `!` = There are unstaged changes in the working tree (`LocalWorkingStatus`)
+  - `~` = There are uncommitted changes i.e. staged changes in the working tree waiting to be committed (`LocalStagedStatus`)
+  - None = There are no unstaged or uncommitted changes to the working tree (`LocalDefault`)


These three statuses should probably include their Symbol suffix now.

dahlbyk · 2018-05-07T03:39:46Z

README.md

+
+![[master ≡] ~\GitHub\posh-git&#10;02-18 14:04:35 38> ][prompt-custom]
+
+If you'd like to make any of these changes permanent i.e. available whenever you start PowerShell, put the corresponding


Comma after permanent?

dahlbyk · 2018-05-07T03:40:43Z

README.md

+the current dir is in a Git repository.
+To simplify the layout, `DP` is being used as an abbreviation for `DefaultPrompt` settings.
+
+Default prompt layout (DP is short for DefaultPrompt):


Does DP need to be explained twice?

rkeithhill · 2018-05-07T04:20:44Z

Good catches!! Thanks

Add MD024 to markdown linter disable list. With CHANGELOG we have multiple headers with same name e.g. Added, Changed, Removed, Fixed.

dahlbyk · 2018-05-07T15:31:37Z

@rkeithhill I practiced a bit of git-fu to separate your formatting/structure changes from actual content changes in 5c0170c. I think it's a bit easier to double-check content changes that way.

I verified the only difference before/after my changes was a few MD rules (no-inline-html, no-bare-urls, no-space-in-code):

diff --git a/.vscode/settings.json b/.vscode/settings.json
index 5caf064..06cdcdb 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -4,6 +4,11 @@
     "markdownlint.config": {
         "MD013": false,
         "MD024": false,
-        "MD029": false
+        "MD029": false,
+        "MD033": {
+            "allowed_elements": [ "kbd" ]
+        },
+        "MD034": false,
+        "MD038": false
     }
 }

Beyond that:

I put back an "install with Chocolatey" section, with slightly adjusted copy.
Fixed an intra-README link.

rkeithhill · 2018-05-07T15:44:15Z

README.md

@@ -248,7 +248,7 @@ For example, a status of `[master ≡ +0 ~2 -1 | +1 ~1 -0]` corresponds to the f
 ## Customization variables

 posh-git adds variables to your session to let you customize it, including `$GitPromptSettings`, `$GitTabSettings`, and `$TortoiseGitSettings`.
-For an example of how to configure your PowerShell profile script to import the posh-git module and create a custom prompt function that displays git status info, see the [Customizing Your PowerShell Prompt](#step-3-optional-customize-your-powershell-prompt) section below.
+For an example of how to configure your PowerShell profile script to import the posh-git module and create a custom prompt function that displays git status info, see the [Customizing Your PowerShell Prompt](#customizing-the-posh-git-prompt) section below.


Good catch - again!

rkeithhill · 2018-05-07T15:46:21Z

Looks good. I think the only thing we need to do before a beta.2 is review/update the CHANGELOG. As for a final release, I still want to tackle the path eliding feature. Maybe tab expansion as well. I've been playing around with TabExpansionPlusPlus - but this might take a while.

dahlbyk · 2018-05-07T18:58:29Z

Looks good. I think the only thing we need to do before a beta.2 is review/update the CHANGELOG.

👍

As for a final release, I still want to tackle the path eliding feature.

👍

Maybe tab expansion as well. I've been playing around with TabExpansionPlusPlus - but this might take a while.

I'm inclined to push this to 2.0.

The two big things yet on my 1.0 list:

Move ssh-agent stuff into a separate module.
Figure out if the Chocolatey install/uninstall needs to change, perhaps just proxying PowerShellGet?

rkeithhill requested a review from dahlbyk May 6, 2018 03:20

rkeithhill mentioned this pull request May 6, 2018

WIP - updates to README for 1.0.0 release #529

Closed

dahlbyk requested changes May 6, 2018

View reviewed changes

dahlbyk requested changes May 7, 2018

View reviewed changes

rkeithhill added 2 commits May 7, 2018 09:42

Add markdownlint and clean up warnings

6705b1d

Trying a minor re-org with a TOC

5f3c39a

Add MD024 to markdown linter disable list. With CHANGELOG we have multiple headers with same name e.g. Added, Changed, Removed, Fixed.

dahlbyk force-pushed the rkeithhill/update-readme-v1 branch from b12bdf8 to 0ef0a84 Compare May 7, 2018 15:18

dahlbyk approved these changes May 7, 2018

View reviewed changes

rkeithhill commented May 7, 2018

View reviewed changes

rkeithhill and others added 2 commits May 7, 2018 13:58

Update README.md for v1.0.0 release

b6ade29

Restore Chocolatey install section

9d0e02d

dahlbyk force-pushed the rkeithhill/update-readme-v1 branch from 0ef0a84 to 9d0e02d Compare May 7, 2018 18:59

dahlbyk merged commit 0a29c44 into master May 7, 2018

dahlbyk deleted the rkeithhill/update-readme-v1 branch May 7, 2018 19:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update README.md for v1.0.0 release #572

Update README.md for v1.0.0 release #572

rkeithhill commented May 6, 2018

dahlbyk left a comment

dahlbyk May 6, 2018

dahlbyk May 6, 2018

dahlbyk May 6, 2018

rkeithhill May 6, 2018

dahlbyk May 6, 2018

dahlbyk May 6, 2018

rkeithhill May 6, 2018

dahlbyk May 6, 2018

dahlbyk May 6, 2018

dahlbyk May 6, 2018

rkeithhill commented May 6, 2018

dahlbyk commented May 7, 2018

dahlbyk left a comment

dahlbyk May 7, 2018

dahlbyk May 7, 2018

dahlbyk May 7, 2018

dahlbyk May 7, 2018

dahlbyk May 7, 2018

dahlbyk May 7, 2018

dahlbyk May 7, 2018

dahlbyk May 7, 2018

rkeithhill commented May 7, 2018

dahlbyk commented May 7, 2018

rkeithhill May 7, 2018

rkeithhill commented May 7, 2018

dahlbyk commented May 7, 2018


		![[master ≡] ~\GitHub\posh-git 02-18 14:04:35 38> ][prompt-custom]

		If you'd like to make any of these changes permanent i.e. available whenever you start PowerShell, put the corresponding

Update README.md for v1.0.0 release #572

Update README.md for v1.0.0 release #572

Conversation

rkeithhill commented May 6, 2018

dahlbyk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rkeithhill commented May 6, 2018

dahlbyk commented May 7, 2018

dahlbyk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rkeithhill commented May 7, 2018

dahlbyk commented May 7, 2018

Choose a reason for hiding this comment

rkeithhill commented May 7, 2018

dahlbyk commented May 7, 2018