ready for publish

Author: FaFre

CHANGELOG.md

@@ -1,3 +1,3 @@
-## 1.0.0
+## 0.9.0
 
 - Initial version.

README.md

@@ -0,0 +1,37 @@
+## Overview
+
+This is a simple Dart package that provides fast and secure equality comparison as a `mixin`. This provides great compatibility to exsiting code.
+
+It optionally offers hash caching to improve the speed of e.g. `Map`'s and `Set`'s significantly.
+
+By default the widely spread [Jenkins hash function](https://en.wikipedia.org/wiki/Jenkins_hash_function) is used, but you are free to also implement and provide your own hash engine, suiting your needs.
+
+Objects of any kind are allowed into `hashParameters`. Simple types and the standard collections like `List`, `Iterable`, `Map` an `Set` are supported by default. When you use own classes make sure to use the `FastEquatable` mixin as well, or make sure at least `hashCode` and `operator ==` are overriden.
+
+## Example
+
+```dart
+class FastEquatableCached with FastEquatable {
+  final String value1;
+  final List<String>? value2;
+
+  FastEquatableCached(this.value1, this.value2);
+
+  @override
+  //This is a immutable object, so we want to cache the hash
+  bool get cacheHash => true;
+
+  @override
+  List<Object?> get hashParameters => [value1, value2];
+}
+```
+
+## Benchmark
+
+In the `example` you will find a benchmark code, showing off the resulting speed improvement.
+
+```
+equatable for 1000000 elements(RunTime): 8583044.5 us.
+fast_equatable (uncached) for 1000000 elements(RunTime): 8493327.5 us.
+fast_equatable (cached) for 1000000 elements(RunTime): 3329455.5 us.
+```

example/CHANGELOG.md

@@ -48,7 +48,7 @@ class EquatableBenchmark extends BenchmarkBase {
 
   EquatableBenchmark(this._randsValA, this._randsValB)
       : assert(_randsValA.length == _randsValB.length),
-        super('Equatable for ${_randsValA.length} elements');
+        super('equatable for ${_randsValA.length} elements');
 
   @override
   void setup() {
@@ -74,7 +74,7 @@ class FastEquatableUncachedBenchmark extends BenchmarkBase {
 
   FastEquatableUncachedBenchmark(this._randsValA, this._randsValB)
       : assert(_randsValA.length == _randsValB.length),
-        super('Fast Equatable (uncached) for ${_randsValA.length} elements');
+        super('fast_equatable (uncached) for ${_randsValA.length} elements');
 
   @override
   void setup() {
@@ -100,7 +100,7 @@ class FastEquatableCachedBenchmark extends BenchmarkBase {
 
   FastEquatableCachedBenchmark(this._randsValA, this._randsValB)
       : assert(_randsValA.length == _randsValB.length),
-        super('Fast Equatable (cached) for ${_randsValA.length} elements');
+        super('fast_equatable (cached) for ${_randsValA.length} elements');
 
   @override
   void setup() {

example/README.md

@@ -1,7 +1,7 @@
 name: fast_equatable
-description: A starting point for Dart libraries or applications.
-version: 1.0.0
-# homepage: https://www.example.com
+description: A simple Dart package that provides fast and secure equality comparison as a mixin. It optionally offers hash caching to improve the speed of Map's and Set's significantly.
+version: 0.9.0
+repository: https://github.com/FaFre/fast_equatable
 
 environment:
   sdk: ">=2.12.0 <3.0.0"