Update the changelog and readme for v0.1.0 release (#11)

Author: daxian-dbw

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## [0.1.0] - 2022-04-06
+
+Initial release of the `CompletionPredictor` module:
+1. Provides prediction results based on tab completion of the user's input using a separate Runspace.
+1. Enable syncing some states between the PowerShell console default Runspace and the separate Runspace, including the current working directory, variables, and loaded modules.
+
+Known limitations:
+1. Prediction on command names is currently disabled because tab completion on command names usually exceeds the timeout limit set by PSReadLine for the predictive intellisense feature, which is 20ms. Different approaches will need to be explored for this, such as
+   - building an index for available commands like the module analysis cache, or
+   - reusing tab completion results in certain cases, so further user input will be used to filter the existing tab completion results instead of always triggering new tab completion requests.
+1. Prediction on command arguments is currently disabled due to the same reason.
+   - the default argument completion action is to enumerate file system items, which is slow in our current implementation. But this can be improved by special case the file system provider, so as to call .NET APIs directly when operating in the `FileSystemProvider`.
+   - some custom argument completers are slow, especially those for native commands as they usually have to start an external process. This can potentially be improved by building index for common native commands.

README.md

@@ -12,6 +12,6 @@ Run `.\build.ps1` from PowerShell to build the project. The module will be publi
 
 > NOTE: Make sure you use PowerShell 7.2 with PSReadLine 2.2.2.
 
-1. Import the module by `Import-Module .\bin\CompletionPredictor`.
-2. Enable prediction from the plugin source for PSReadLine: `Set-PSReadLineOption -PredictionSource Plugin`.
-3. Switch between the `Inline` and `List` prediction views, by pressing <kbd>F2</kbd>.
+1. Install the module by `Install-Module -Name CompletionPredictor -Repository PSGallery`
+1. Enable prediction from the plugin source for PSReadLine: `Set-PSReadLineOption -PredictionSource HistoryAndPlugin`
+1. Switch between the `Inline` and `List` prediction views, by pressing <kbd>F2</kbd>