From 1e9b50da56fd273728feddbda637a0972ae326c9 Mon Sep 17 00:00:00 2001
From: CodingNinja <CodingNinja@outlook.com>
Date: Fri, 28 Jul 2023 18:07:54 +0800
Subject: [PATCH] Update README.md

---
 README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 70 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 603eac6..b4b4867 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,89 @@
 # WpfObservableRangeCollection
 
+[![NuGet](https://buildstats.info/nuget/WpfObservableRangeCollection?includePreReleases=true)](https://www.nuget.org/packages/WpfObservableRangeCollection/)
+[![Target framework](https://img.shields.io/badge/support-.NET_6.0--Windows-blue)](https://github.com/CodingOctocat/WpfObservableRangeCollection)
+[![GitHub issues](https://img.shields.io/github/issues/CodingOctocat/WpfObservableRangeCollection)](https://github.com/CodingOctocat/WpfObservableRangeCollection/issues)
+[![GitHub stars](https://img.shields.io/github/stars/CodingOctocat/WpfObservableRangeCollection)](https://github.com/CodingOctocat/WpfObservableRangeCollection/stargazers)
+[![GitHub license](https://img.shields.io/github/license/CodingOctocat/WpfObservableRangeCollection)](https://github.com/CodingOctocat/WpfObservableRangeCollection/blob/master/LICENSE)
+[![CodeFactor](https://www.codefactor.io/repository/github/codingoctocat/wpfobservablerangecollection/badge)](https://www.codefactor.io/repository/github/codingoctocat/wpfobservablerangecollection)
+
 Provides ObservableRangeCollection and its WPF version, including AddRange, InsertRange, RemoveRange/RemoveAll, Replace/ReplaceRange methods for bulk operation to avoid frequent update notification events.
 
----
+## NuGet Package Manager
 
-[![NuGet](https://buildstats.info/nuget/WpfObservableRangeCollection?includePreReleases=true)](https://www.nuget.org/packages/WpfObservableRangeCollection/)
+    PM> Install-Package WpfObservableRangeCollection
+
+## .NET CLI
+
+    dotnet add package WpfObservableRangeCollection
 
 ---
 
 ## Classes
-- `ObservableRangeCollection`: Represents a dynamic data collection that provides notifications when items get added, removed, or when the whole list is refreshed.
+- `ObservableRangeCollection`: An ObservableCollection that supports bulk operations to avoid frequent update notification events.
   > Forked from [weitzhandler/rangeobservablecollection-cs](https://gist.github.com/weitzhandler/65ac9113e31d12e697cb58cd92601091#file-rangeobservablecollection-cs)
 
-- `WpfObservableRangeCollection`: Wpf version of ObservableRangeCollection with CollectionView support.
+- `WpfObservableRangeCollection`: WPF version of ObservableRangeCollection with CollectionView support.
   > Forked from [weitzhandler/wpfobservablerangecollection-cs](https://gist.github.com/weitzhandler/65ac9113e31d12e697cb58cd92601091#file-wpfobservablerangecollection-cs)
 
+# Usage
+
+```csharp
+var collection = new WpfObservableRangeCollection<int>();
+collection.AddRange(Enumerable.Range(0,10));
+```
+> { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 }
+
+</br>
+
+```csharp
+collection.RemoveRange(index: 5, count: 3);
+```
+> { 0, 1, 2, 3, 4, ~~5, 6, 7~~ 8, 9 }
+
+</br>
+
+```csharp
+// You can also receive the return value to get the number of items that were successfully removed.
+// removed here is 2.
+int removed = collection.RemoveRange(new[] { 1, 3, 5 });
+```
+> { 0, ~~1~~ 2, ~~3~~ 4, 8, 9 }
+
+</br>
+
+```csharp
+collection.InsertRange(index: 2, collection: Enumerable.Range(10, 7));
+```
+> { 0, 2, 10, 11, 12, 13, 14, 15, 16, 4, 8, 9 }
+
+</br>
+
+```csharp
+// This method is roughly equivalent to RemoveRange, then InsertRange.
+// When index and count are equal to 0, it is equivalent to InsertRange(0, collection).
+// changed here is 0.
+int changed = collection.ReplaceRange(index: 6, count: 3, new[] { -1, -2, -3 });
+```
+> { 0, 2, 10, 11, 12, 13, -1, -2, -3, 4, 8, 9 }
+
+</br>
+
+```csharp
+// Clears the current collection and replaces it with the specified item.
+collection.Replace(42);
+```
+> { 42 }
+
+</br>
+
+- If duplicate items are not allowed in the collection, set `AllowDuplicates = false`, and you can specify the `Comparer = xxx`.
+- Most of the extended methods have return values to indicate changes in the number of collections.
+
 ## Why WpfObservableRangeCollection?
 See [ObservableCollection Doesn't support AddRange method, so I get notified for each item added, besides what about INotifyCollectionChanging? - StackOverflow](https://stackoverflow.com/q/670577/4380178)
 
-I've searched the web for some ObservableCollections that have *Range methods, but they all raise various exceptions(and some strange problems) in certain specific situations:
+I've searched the web for some ObservableCollections that have *\*Range* methods, but they all raise various exceptions(and some strange problems) in certain specific situations:
 - System.NotSupportedException: Range actions are not supported.
 - System.InvalidOperationException: The "x" index in the collection change event is not valid for collections of size "y".
 - More? I'm not sure. I forgot.