Skip to content

Commit

Permalink
docs: provide minimal usage example
Browse files Browse the repository at this point in the history
  • Loading branch information
antongolub committed Mar 16, 2024
1 parent 8a9442b commit ae22952
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
– eat all kinds of materials.
</sup>

# 🔬
<h1> 🔬 </h1>

> 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.

Expand All @@ -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
Expand Down

0 comments on commit ae22952

Please sign in to comment.