Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md for .NET support #992

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,11 @@ The Apache Lucene.NET website is at:

### Lucene.NET 4.8.0

- [.NET 8.0](https://dotnet.microsoft.com/download/dotnet/8.0)
- [.NET 6.0](https://dotnet.microsoft.com/download/dotnet/6.0)
- [.NET Standard 2.1](https://docs.microsoft.com/en-us/dotnet/standard/net-standard)
- [.NET Standard 2.0](https://docs.microsoft.com/en-us/dotnet/standard/net-standard)
- .NET Framework 4.5
- .NET Framework 4.6.2

## Status

Expand All @@ -37,9 +38,9 @@ Working toward Lucene.NET 4.8.0 (currently in BETA)

* The beta version is extremely stable
* Has more than 7800+ passing unit tests
* Integrates well with .NET 6.0, .NET 5.0 and .NET Core 2+
* Integrates well with .NET 8.0 and .NET 6.0 (as well as other unsupported versions)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was just reading a comment yesterday that I left about this. This tends to go out of date faster than we can update it. So, maybe we should just say something along the lines of "Tested daily on all officially supported versions of .NET Core".

The targets have a loose relationship with the runtimes, but I suspect anyone reading this just wants to know if their preferred runtime will work. If anyone wants to see our supported target frameworks, it is all on the NuGet package page. Maybe we should just drop a link to: https://www.nuget.org/packages/Lucene.Net/absoluteLatest#supportedframeworks-body-tab, which will always be up to date.

Also, this information was copied over to our homepage, which will also need to be updated: https://lucenenet.apache.org/. At one point, these 2 descriptions were identical, but they don't remain in sync because they don't share the same source file.

* Supports .NET Standard 2.1 and .NET Standard 2.0
* Supports .NET Framework 4.5+
* Supports .NET Framework 4.6.2+
* Some developers already use it in production environments

## Download
Expand Down Expand Up @@ -125,7 +126,7 @@ There are several demos implemented as simple console applications that can be c

There is also a dotnet command line tool available on NuGet. It contains all of the demos as well as tools maintaining your Lucene.NET index, featuring operations such as splitting, merging, listing segment info, fixing, deleting segments, upgrading, etc. Always be sure to back up your index before running any commands against it!

- [Prerequisite: .NET 6.0 Runtime or Higher](https://dotnet.microsoft.com/en-us/download/dotnet)
- [Prerequisite: .NET 8.0 Runtime or Higher](https://dotnet.microsoft.com/en-us/download/dotnet)

```
dotnet tool install lucene-cli -g --version 4.8.0-beta00015
Expand Down