add README

.changeset/green-clouds-sniff.md

@@ -0,0 +1,5 @@
+---
+"timer-abort-controller": patch
+---
+
+add README and rename the class

README.md

@@ -1,2 +1,35 @@
-## Description
-The repo contains a handy class for AbortController interaction
+# Timer Abort Controller
+
+## A wrapper for NodeJS AbortController class that makes interaction easier
+
+## Installation
+
+```bash
+$ npm i timer-abort-controller
+```
+
+#### This code snippet shows how it works
+
+```javascript
+import { TimerAbortController } from 'timer-abort-controller';
+
+const timeToWait = 1000;
+const timeToResolve = 2000;
+
+(async function() {
+    const p = new Promise<string>((res) => {
+        setTimeout(() => {
+            res(`promise resolved after ${timeToResolve} milliseconds`);
+        }, timeToResolve);
+    });
+
+    try {
+        const result = await TimerAbortController.resolveInTime<string>(p, timeToWait);
+
+        console.log(result);
+    } catch (error) {
+        console.log(`promise aborted after ${timeToWait} milliseconds`);
+        console.log(error);
+    }
+})();
+```

index.ts

@@ -1,4 +1,4 @@
-export class AbortControllerTimer {
+export class TimerAbortController {
     static async resolveInTime<T>(
         promise: Promise<T>,
         timeLimit = 10_000,
@@ -11,7 +11,7 @@ export class AbortControllerTimer {
             timeLimit,
         );
 
-        return AbortControllerTimer.resolve<T>(promise, signal, timeout);
+        return TimerAbortController.resolve<T>(promise, signal, timeout);
     }
 
     private static async resolve<T>(