Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
c4spar committed May 13, 2021
1 parent a8266c7 commit 5663be0
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,17 @@
#!/usr/bin/env dzx
/// <reference path="https://deno.land/x/dzx/types.d.ts" />

$.verbose = true;
$.shell = "/usr/local/bin/zsh";

console.log(`Hello from ${$.blue.bold("dzx")}!`);

const branch = await $`git branch --show-current`;
await $`dep deploy --branch=${branch}`;

cd("src/foo");
cd("src/bar");

await Promise.all([
$`deno lint --unstable`,
$`deno fmt --check`,
Expand All @@ -57,9 +63,12 @@ await $`mkdir /tmp/${name}`; // <-- string will be safly quoted to: /tmp/'foo ba
## Install

```
deno install --allow-all -r -f https://deno.land/x/dzx/dzx.ts
deno install --allow-all -r -f --unstable https://deno.land/x/dzx/dzx.ts
```

> `--unstable` is required for the `bundle` command which uses `Deno.emit`, for
> `std/fs/copy` and for web workers.
## Usage

To start writing a dzx script, add next shebang at the beginning of your script:
Expand Down

0 comments on commit 5663be0

Please sign in to comment.