From cb1418abd862e7e2fad75542ea5869b42710b378 Mon Sep 17 00:00:00 2001 From: Benjamin Fischer Date: Sun, 9 May 2021 15:57:08 +0200 Subject: [PATCH] docs: update readme --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a82c168..c4a6742 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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 /// ``` @@ -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"; ```