Skip to content

Commit 5283203

Browse files
author
Victor Martins
committed
docs: add usage documentation
1 parent b6a83f3 commit 5283203

File tree

4 files changed

+19
-3
lines changed

4 files changed

+19
-3
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,17 @@ Enables the creation of child processes (workers) that run simultaneously and sh
55
## Installation
66

77
```shell
8-
$ yarn add node-clusterize
8+
$ yarn add @doris.mobi/node-clusterize
99
```
1010

1111
## Usage
1212

13-
...WIP
13+
```typescript
14+
import { ClusterService } from '@doris.mobi/node-clusterize'
15+
16+
const application = () => {
17+
// your node application logic
18+
}
19+
20+
ClusterService.clusterize(application)
21+
```

package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,5 +50,8 @@
5050
},
5151
"files": [
5252
"dist"
53-
]
53+
],
54+
"dependencies": {
55+
"@doris.mobi/node-clusterize": "^1.1.25"
56+
}
5457
}

src/test.ts

Whitespace-only changes.

yarn.lock

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -466,6 +466,11 @@
466466
dependencies:
467467
"@cspotcode/source-map-consumer" "0.8.0"
468468

469+
"@doris.mobi/node-clusterize@^1.1.25":
470+
version "1.1.25"
471+
resolved "https://registry.yarnpkg.com/@doris.mobi/node-clusterize/-/node-clusterize-1.1.25.tgz#26b2ffe478d00d93e3973679732063c4cb865bfe"
472+
integrity sha512-x/l3kzvXrQrFcbHm87dCSDas2weAysNl0YMhYhgJnNv5Ark5eRm0sO47N68q2cpZsON8fyCX9Rn+vV8Mj3K0SQ==
473+
469474
"@eslint/eslintrc@^1.2.1":
470475
version "1.2.1"
471476
resolved "https://registry.yarnpkg.com/@eslint/eslintrc/-/eslintrc-1.2.1.tgz#8b5e1c49f4077235516bc9ec7d41378c0f69b8c6"

0 commit comments

Comments
 (0)