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 02cb655 commit 251add4
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,18 +155,6 @@ Combile an dzx script to a standalone binary. Can also read from stdin.
dzx compile ./examplte.ts --allow-read --allow-env --allow-run
```

### `dzx help [command]`

Show this help or the help of a sub-command.

### `dzx completions [shell]`

Generate shell completions for `bash`, `fish` and `zsh`.

```shell
source <(dzx completions zsh)
```

## API

### Methods
Expand Down Expand Up @@ -258,18 +246,30 @@ Deno's `std/flags` module.

### Options

#### `$.verbose`

Enable debugging output.

#### `$.shell`

Set the current shel.

#### `$.mainModule`

The dzx main module.

#### `$.verbose`

Enable debugging output.

#### `$.throwErrors`

Throw errors instead of calling `Deno.exit`.

#### `$.startTime`

Th execution start time in ms.

#### `$.time`

The time left since execution start (now() - $.startTime).

#### `$.quote`

Parser method that is used to safely quote strings. Used by: `` $`command` ``
Expand Down

0 comments on commit 251add4

Please sign in to comment.