fix known problems

Author: codimiracle

.gitignore

@@ -128,6 +128,3 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
-
-# release files
-.dist

README.md

@@ -9,8 +9,9 @@ a structure for set that refresh element if same id of element is exists
 npm install refresh-set
 ```
 ## Usage
+1. using refresh set to hold elements, and update it last time
 ```typescript
-import RefreshSet from 'refresh-set';
+import { RefreshSet } from 'refresh-set';
 
 type Element = {
   id: string;
@@ -26,6 +27,50 @@ set.add({ id: '1', value: 3 });
 console.log(set.toArray()); // [{ id: '1', value: 3 }, { id: '2', value: 2 }
 ```
 
+2. change identifier of element
+```typescript
+import { RefreshSet } from 'refresh-set';
+
+type Element = {
+  key: string;
+  value: number;
+};
+
+// default id supplier is element.id
+const set = new RefreshSet<Element>({
+  idSupplier: (element) => element.key,
+});
+
+set.add({ key: '1', value: 1 });
+set.add({ key: '2', value: 2 });
+set.add({ key: '1', value: 3 });
+
+console.log(set.toArray()); // [{ key: '1', value: 3 }, { key: '2', value: 2 }
+```
+
+3. custom refresh method
+```typescript
+import { RefreshSet, RefreshPolicy } from 'refresh-set';
+
+type Element = {
+  id: string;
+  value: number;
+};
+
+const set = new RefreshSet<Element>({
+  policy: RefreshPolicy.MERGER,
+  merger: (oldElement, newElement) => {
+    newElement.value = oldElement.value + 1;
+  },
+});
+
+set.add({ id: '1', value: 1 });
+set.add({ id: '2', value: 2 });
+set.add({ id: '1', value: 3 });
+
+console.log(set.toArray()); // [{ id: '1', value: 4 }, { id: '2', value: 2 }
+```
+
 ## contributing
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

package.json

@@ -1,9 +1,12 @@
 {
   "name": "refresh-set",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "a refresh set after repeat add into set",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsc",
     "test": "jest"