UNPKG

1.59 kBMarkdownView Raw
1# @geia/promise-lobby
2
3[![npm version][badge-npm-version]][url-npm]
4[![npm download monthly][badge-npm-download-monthly]][url-npm]
5[![npm download total][badge-npm-download-total]][url-npm]
6[![npm dependents][badge-npm-dependents]][url-github]
7[![npm license][badge-npm-license]][url-npm]
8[![pp install size][badge-pp-install-size]][url-pp]
9[![github commit last][badge-github-last-commit]][url-github]
10[![github commit total][badge-github-commit-count]][url-github]
11
12[//]: <> (Shields)
13[badge-npm-version]: https://flat.badgen.net/npm/v/@geia/promise-lobby
14[badge-npm-download-monthly]: https://flat.badgen.net/npm/dm/@geia/promise-lobby
15[badge-npm-download-total]:https://flat.badgen.net/npm/dt/@geia/promise-lobby
16[badge-npm-dependents]: https://flat.badgen.net/npm/dependents/@geia/promise-lobby
17[badge-npm-license]: https://flat.badgen.net/npm/license/@geia/promise-lobby
18[badge-pp-install-size]: https://flat.badgen.net/packagephobia/install/@geia/promise-lobby
19[badge-github-last-commit]: https://flat.badgen.net/github/last-commit/hoyeungw/geia
20[badge-github-commit-count]: https://flat.badgen.net/github/commits/hoyeungw/geia
21
22[//]: <> (Link)
23[url-npm]: https://npmjs.org/package/@geia/promise-lobby
24[url-pp]: https://packagephobia.now.sh/result?p=@geia/promise-lobby
25[url-github]: https://github.com/hoyeungw/geia
26
27##### Fork cluster with configs
28
29#### Install
30```console
31$ npm install @geia/promise-lobby
32```
33
34#### Usage
35```js
36import { Institute } from '@geia/promise-lobby'
37Institute.build({ exec:'path-to-worker/worker.js', env:{} })
38```
39
40#### Meta
41[LICENSE (MIT)](LICENSE)