Update README.md (#2)

Author: daxian-dbw

README.md

@@ -1 +1,45 @@
-# command-not-found
+# command-not-found
+
+The `command-not-found` module is a feedback provider plugin for PowerShell.
+This feedback provider depends on the `command-not-found` utility,
+which is often available on Linux by default,
+to provide suggestions when a native command cannot be found.
+
+`bash` also calls the `command-not-found` utility to provide suggestions when a command cannot be found.
+But this feedback provider plugin does more than that,
+thanks to the [command-line predictor][command-line-predictor] feature in PowerShell.
+It also implements the `ICommandPredictor` interface and serves as a predictor.
+When the resulted feedback contains actionable items, such as commands to run,
+they will be used as predictive suggestions to streamline the user's command-line experience.
+
+</br>
+
+![FeedbackProvider](./tools/images/FeedbackProvider.gif)
+
+## Requirements
+
+The `command-not-found` plugin is built on the `IFeedbackProvider` interface,
+which is available with PowerShell `7.4.0-preview.2` or above.
+To display prediction suggestions from the `command-not-found`,
+you need [PSReadLine 2.2.6][psreadline-226] or above.
+
+- PowerShell `7.4.0-preview.2` or above
+- PSReadLine `2.2.6` or above
+
+## Documentation
+
+PowerShell feedback providers and predictors are written in C# and registered with the PowerShell [Subsystem Plugin Model][subsystem-plugin-model].
+To learn more, see "How to create a feedback provider" and ["How to create a command-line predictor"][how-to-create-predictor].
+
+## Build
+
+Make sure the [latest .NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) is installed
+and available in your `PATH` environment variable.
+Run `.\build.ps1` from `pwsh` to build the project.
+The module will be published to `.\bin\command-not-found` by a successful build.
+
+
+[command-line-predictor]: https://learn.microsoft.com/en-us/powershell/scripting/learn/shell/using-predictors?view=powershell-7.3
+[psreadline-226]: https://www.powershellgallery.com/packages/PSReadLine/2.2.6
+[subsystem-plugin-model]: https://docs.microsoft.com/powershell/scripting/learn/experimental-features#pssubsystempluginmodel
+[how-to-create-predictor]: https://docs.microsoft.com/powershell/scripting/dev-cross-plat/create-cmdline-predictor

src/FeedbackProvider.cs

@@ -6,12 +6,12 @@
 
 namespace Microsoft.PowerShell.FeedbackProvider;
 
-public sealed class UnixCommandNotFound : IFeedbackProvider, ICommandPredictor
+public sealed class LinuxCommandNotFound : IFeedbackProvider, ICommandPredictor
 {
     private readonly Guid _guid;
     private List<string>? _candidates;
 
-    internal UnixCommandNotFound(string guid)
+    internal LinuxCommandNotFound(string guid)
     {
         _guid = new Guid(guid);
     }
@@ -22,7 +22,7 @@ internal UnixCommandNotFound(string guid)
 
     public string Name => "cmd-not-found";
 
-    public string Description => "The built-in feedback/prediction source for the Unix command utility.";
+    public string Description => "The built-in feedback/prediction source for the Linux command utility.";
 
     #region IFeedbackProvider
 
@@ -176,7 +176,7 @@ public class Init : IModuleAssemblyInitializer, IModuleAssemblyCleanup
 
     public void OnImport()
     {
-        var feedback = new UnixCommandNotFound(Id);
+        var feedback = new LinuxCommandNotFound(Id);
         SubsystemManager.RegisterSubsystem(SubsystemKind.FeedbackProvider, feedback);
         SubsystemManager.RegisterSubsystem(SubsystemKind.CommandPredictor, feedback);
     }