README.md/lucene-cli docs: Added note about matching the version numb…

…er of the CLI to Lucene.NET
sscctech · Feb 9, 2021 · 1ff46c0 · 1ff46c0
1 parent b41bdb2
commit 1ff46c0
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -120,6 +120,8 @@ There is also a dotnet command line tool available on NuGet. It contains all of
 dotnet tool install lucene-cli -g --version 4.8.0-beta00012
 ```
 
+> NOTE: The version of the CLI you install should match the version of Lucene.NET you use.
+
 Once installed, you can explore the commands and options that are available by entering the command `lucene`.
 
 [lucene-cli Documentation](https://github.com/apache/lucenenet/blob/master/src/dotnet/tools/lucene-cli/docs/index.md)

diff --git a/src/dotnet/tools/lucene-cli/docs/index.md b/src/dotnet/tools/lucene-cli/docs/index.md
@@ -1,6 +1,6 @@
-# Lucene.Net command line interface (CLI) tools
+# Lucene.NET command line interface (CLI) tools
 
-The Lucene.Net command line interface (CLI) is a new cross-platform toolchain with utilities for maintaining Lucene.Net and demos for learning basic Lucene.Net functionality.
+The Lucene.NET command line interface (CLI) is a new cross-platform toolchain with utilities for maintaining Lucene.NET and demos for learning basic Lucene.NET functionality.
 
 ## Prerequisites
 
@@ -14,7 +14,9 @@ Perform a one-time install of the lucene-cli tool using the following dotnet CLI
 dotnet tool install lucene-cli -g --version [EnvVar:LuceneNetVersion]
 ```
 
-You may then use the lucene-cli tool to analyze and update Lucene.Net indexes and use its demos.
+> NOTE: The version of the CLI you install should match the version of Lucene.NET you use.
+
+You may then use the lucene-cli tool to analyze and update Lucene.NET indexes and use its demos.
 
 ## CLI Commands
 
@@ -27,7 +29,7 @@ The following commands are installed:
 
 ## Command structure
 
-CLI command structure consists of the driver ("lucene"), the command, and possibly command arguments and options. You see this pattern in most CLI operations, such as checking a Lucene.Net index for problematic segments and fixing (removing) them:
+CLI command structure consists of the driver ("lucene"), the command, and possibly command arguments and options. You see this pattern in most CLI operations, such as checking a Lucene.NET index for problematic segments and fixing (removing) them:
 
 ```
 lucene index check C:\my-index --verbose