diff --git a/README.md b/README.md index 5e82864..de0d20b 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ – eat all kinds of materials. -# 🔬 +

🔬

+ > This subproject is a kind of experiment, addressed to the [google/zx/issues/589](https://github.com/google/zx/issues/589). Just a testing ground for verifying ideas and approaches aimed at improve the [zx](https://github.com/google/zx) architecture. @@ -19,6 +20,21 @@ Just a testing ground for verifying ideas and approaches aimed at improve the [z * The context object at every layer is accessible fo modify. * Typings are mostly represented by interfaces, so it's easy to tweak up if necessary. +## Install +```bash +yarn add zurk +``` + +## API + +```ts +import {$, exec, zurk} from 'zurk' + +const r1 = exec({sync: true, cmd: 'echo foo'}) +const r2 = await zurk({sync: false, cmd: 'echo foo'}) +const r3 = await $`echo foo` +``` + ## Proposals - [x] Promises in cmd literals ```ts