Update usage

flutter-cavalry · Dec 2, 2023 · a07c457 · a07c457
1 parent 69cdf10
commit a07c457
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,3 +4,11 @@
 # immutable_ordered_map
 
 A dart implementation of Immutable ordered map. A port of [orderedmap](https://github.com/marijnh/orderedmap).
+
+## Usage
+
+Refer to the [original repo](https://github.com/marijnh/orderedmap) for usage. There are some breaking changes though:
+
+- The original `OrderedMap` is renamed to `ImmutableOrderedMap` for clarity.
+- `ImmutableOrderedMap` is now a generic class with two type parameters: `K` and `V`.
+- The original `OrderedMap.toObject` is renamed to `ImmutableOrderedMap.toMap` (Dart doesn't have a map-like Object type, use `Map<T, V>` instead).