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 9, 2021
1 parent 3542c19 commit cb1418a
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,10 @@ deno install --allow-all -r -f https://deno.land/x/dzx/dzx.ts

## Documentation

You can write your scripts in a file with .js, .mjs or .ts extension.

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

```
#!/usr/bin/env zx
#!/usr/bin/env dzx
```

Now you will be able to run your script as:
Expand All @@ -75,7 +73,7 @@ If you want to use typescript you need to add a tripple slash reference for the
typings at the top of the file, but not before the shebang line.

```
#!/usr/bin/env zx
#!/usr/bin/env dzx
/// <reference path="https://deno.land/x/dzx/types.d.ts" />
```

Expand All @@ -91,7 +89,7 @@ You can also import all symbol directly from `dzx/mod.ts` instead of using
globals.

```ts
#!/usr/bin/env zx
#!/usr/bin/env dzx
import { $ } from "https://deno.land/x/dzx/mod.ts";
```

Expand Down

0 comments on commit cb1418a

Please sign in to comment.