Merge pull request 53805 from olivida/features/improve_documentation …

…into master

Improve documentation for CTP release

Install.md

@@ -4,30 +4,28 @@ This document explains where to copy the JAR and how to configure Git to use the
 
 System Requirements
 -------------------
-Great care was taken to avoid using any features of Java that would impact compatibility with Java 6.  If you find a compatibility issue, please report it.
+Great care was taken to avoid using any features of Java that would impact compatibility with Java 6.  If you find a compatibility issue, please report it and provide as many details about your platform as necessary to reproduce the problem.
 1. Java 6+
 2. Git 1.9+
 
 How to install
 --------------
-1. Copy the `git-credential-helper-0.1.0.jar` file somewhere safe and stable, such as `%APPDATA%/git-credential-helper/` on Windows or `~/Library/Application Support/git-credential-helper/` on Mac or `~/git-credential-helper/` on Linux.
-2. Configure the `credential.helper` setting to launch Java with the path to the JAR (make sure you surround the whole value with 'single quotes' in Bash and "double quotes" in the Windows Command Prompt):
+1. Copy the `git-credential-helper-0.1.3.jar` file somewhere safe and stable, such as `%APPDATA%/git-credential-helper/` on Windows or `~/Library/Application Support/git-credential-helper/` on Mac or `~/git-credential-helper/` on Linux.
+2. Configure the `credential.helper` setting to launch Java with the absolute path to the JAR (make sure you surround the whole value with 'single quotes' in Bash and "double quotes" in the Windows Command Prompt, _as well as_ either double-quoting values containing spaces or escaping the spaces with a backslash):
 
-```git config --global credential.helper '!java -jar path/to/git-credential-helper-0.1.0.jar'``` 
+```git config --global credential.helper '!java -Ddebug=false -jar /path/to\ folder\ with\ spaces/git-credential-helper-0.1.3.jar'```
 
 How to enable (or disable) debug mode
 -------------------------------------
-This will turn on tracing and assertions, producing a lot of output to `stderr`.  Only turn this on temporarily, when trying to isolate a defect.
+Debug mode will turn on tracing and assertions, producing a lot of output to `stderr`.  Only turn this on temporarily, when trying to isolate a defect.
 1. Retrieve the value of the `credential.helper` configuration:
 
  ```git config --global --get credential.helper```
 
  ...it should look like this:
 
- ```!java -jar path/to/git-credential-helper-0.1.0.jar```
-2. Set a new value for the `credential.helper` configuration by inserting `-Ddebug=true` (or `-Ddebug=false` to disable) between `!java` and `-jar` (make sure you surround the whole value with 'single quotes' in Bash and "double quotes" in the Windows Command Prompt):
-
-```git config --global credential.helper '!java -Ddebug=true -jar path/to/git-credential-helper-0.1.0.jar'```
+ ```!java -Ddebug=false -jar /path/to/git-credential-helper-0.1.3.jar```
+2. Set a new value for the `credential.helper` configuration (essentially repeating _installation step 2_, being careful with quoting and spaces), changing the value of the `debug` property to `true` (or `false` to disable).
 
 How to remove or uninstall
 --------------------------

ReadMe.md

@@ -1,2 +1,11 @@
-## VSO Credential Helper
-The VSO Git Credential Helper is fairly simple. It stores and retrieves credentials for accessing Git resources on VSO to and from a secure container.
+Microsoft Git Credential Manager for Java
+=========================================
+The Microsoft Git Credential Manager for Java is fairly simple. It stores and retrieves credentials for accessing Git resources on Visual Studio Online to and from a secure container.
+
+How does it work?
+-----------------
+Once configured with Git, if Git needs credentials for reading from or writing to a Git remote, it sends a request to the program(s) configured as `credential.helper`, as described in [gitcredentials](http://git-scm.com/docs/gitcredentials.html).  If none of the credential helpers have valid credentials, Git will prompt for a username and password and then ask the credential helper(s) to save the values for later retrieval.
+
+The first release of the Microsoft Git Credential Manager for Java works a lot like [git-credential-store](http://git-scm.com/docs/git-credential-store), writing and reading credentials from the file `insecureStore.xml` in your HOME folder.  You can make this file more secure by removing access to it from other users and turning on per-file encryption if your system supports it.
+
+Upcoming releases will support OAuth2 to request authorization from Visual Studio Online, generate least-privilege Personal Access Tokens and then store these using the operating system's secure storage facility.

ReleaseNotes.md

@@ -2,6 +2,10 @@ Release Notes
 =============
 Every release is described here, from latest to earliest.
 
-Version 0.1.0
+Version 0.1.3
+-------------
+Improvements to the documentation.
+
+Version 0.1.2
 -------------
 Initial release of C# port which supports Basic authority only and a plain-text credential store (`~/insecureStore.xml`) making it equivalent to the built-in git-credential-store.