Update description

neon-sunset · Aug 13, 2022 · f453133 · f453133
1 parent 6a6ccb6
commit f453133
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
 # RangeExtensions
 [![CI/CD](https://github.com/neon-sunset/RangeExtensions/actions/workflows/dotnet-releaser.yml/badge.svg)](https://github.com/neon-sunset/RangeExtensions/actions/workflows/dotnet-releaser.yml) [![nuget](https://badgen.net/nuget/v/RangeExtensions/latest)](https://www.nuget.org/packages/RangeExtensions/) [![Coverage Status](https://coveralls.io/repos/github/neon-sunset/RangeExtensions/badge.svg)](https://coveralls.io/github/neon-sunset/RangeExtensions)
 
-Extensions for Range type to support `foreach` and `RangeEnumerable` that implements `IEnumerable<int>`.
-- Correctness is verified against standard `IEnumerable<int>` and `Enumerable.Range` behavior
-- Performance is hand tuned to produce efficient native code with no allocations as long as `RangeEnumerable` isn't boxed into `IEnumerable<int>` (same applies to enumerator)
+This package allows you to use `0..100` in `foreach` expressions and implements `RangeEnumerable` that supports a variety of LINQ-like operations as well as `ICollection<int>` and `IEnumerable<int>`.
+- Correctness is verified against standard `IEnumerable<int>` and `Enumerable.Range` behavior;
+- Performance is hand tuned to produce efficient native code with no allocations as long as `RangeEnumerable` isn't boxed (same applies to enumerator). However, even when boxed it is still faster than `Enumerable.Range`.
 
 ## Features
 ### Range enumeration
 ```cs
-foreach (var i in 0..100)
+foreach (var i in ..100) // you can write 0..Length as just ..Length
 {
     Console.WriteLine(i);
 }

diff --git a/RangeExtensions/RangeEnumerable.cs b/RangeExtensions/RangeEnumerable.cs
@@ -41,6 +41,7 @@ public record struct Enumerator : IEnumerator<int>
     {
         private readonly int _shift;
         private readonly int _end;
+
         private int _current;
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]

diff --git a/RangeExtensions/RangeExtensions.csproj b/RangeExtensions/RangeExtensions.csproj
@@ -1,12 +1,12 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <Authors>neon-sunset</Authors>
     <RepositoryUrl>https://github.com/neon-sunset/RangeExtensions</RepositoryUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageTags>Range;Extensions;LINQ;IEnumerable;foreach;RangeForEach</PackageTags>
     <PackageReadmeFile>README.md</PackageReadmeFile>
-    <Description>Extensions for Range type to support 'foreach' and 'RangeEnumerable' that implements 'IEnumerable'.</Description>
+    <Description>Extensions for Range that add foreach and ICollection/IEnumerable support.</Description>
   </PropertyGroup>
 
   <PropertyGroup>