From 55089b91c950957dda0613e64dd828b44de4216b Mon Sep 17 00:00:00 2001
From: Anton Nesterov <anton@demiurg.io>
Date: Mon, 28 Oct 2024 13:34:29 +0100
Subject: [PATCH] fix readme

---
 README.md    | 27 +++++++++++++++++++--------
 jsr.json     |  2 +-
 package.json |  2 +-
 3 files changed, 21 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 89941cc..f056fca 100644
--- a/README.md
+++ b/README.md
@@ -12,12 +12,23 @@ Offload creates a limited execution pool and can operate in two modes:
 ## Install:
 
 ```bash
-bun add githib:nesterow/offload # or pnpm
+bun add github:nesterow/offload # or pnpm
 ```
 
 ## Usage
 
-Considering following worker:
+Offload accepts three positional arguments: worker path, pool size, and operation mode:
+
+```typescript
+const [task, terminate] = offload<ReturnType, ParamType>(
+  workerPath: string,
+  poolSize: number,
+  mode?: 'bg' | 'cb'
+)
+```
+
+
+Worker's main callback must be wrapped as `handler` and must receive single argument:
 
 ```typescript
 // print.worker.ts
@@ -34,7 +45,7 @@ handler(async (data: string) => {
 ### Callback operation mode
 
 In the callback mode, `print()` will spawn a worker and terminate it after the task is done.
-Maximum of 5 workers may be spawned at the same time, the rest will be queued:
+Maximum of `poolSize` workers may be spawned at the same time, the rest will be queued:
 
 ```typescript
 import { offload } from "@nesterow/offload";
@@ -50,7 +61,7 @@ This is default "safe" option as it allows to call `offload` in any part of the
 
 ### Background operation mode
 
-In the background mode, offload will spawn 5 workers, `print()` will distribute the tasks among them:
+In the background mode, offload will spawn `poolSize` workers, `print()` will distribute the tasks among them:
 
 ```typescript
 import { offload } from "@nesterow/offload";
@@ -67,13 +78,13 @@ Generally it is more effective as it balances the load among the threads and doe
 
 ## Types
 
-Because offload doesn't know params and return types of your worker, you need to pass type arguments manually:
+Because offload doesn't know argument and return types of your worker's handler, you need to pass type arguments manually:
 
 ```typescript
-const [callback, termiate] = offload<ReturnType, ParamType>("./my.worker.ts", 1);
+const [callback, termiate] = offload<ReturnType, ArgType>("./my.worker.ts", 1);
 
-const param: ParamType = {};
-const result: ReturnType = await callback(param: ParamType);
+const arg: ArgType = {};
+const result: ReturnType = await callback(arg);
 ```
 
 ## License
diff --git a/jsr.json b/jsr.json
index 773920d..af1ccbb 100644
--- a/jsr.json
+++ b/jsr.json
@@ -1,5 +1,5 @@
 {
   "name": "@nesterow/offload",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "exports": "./mod.ts"
 }
diff --git a/package.json b/package.json
index 1d29ac1..7300d45 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@nesterow/offload",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "author": {
     "name": "Anton Nesterov",
     "url": "https://github.com/nesterow"