Skip to content

Commit

Permalink
📝 Add CLI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AnandChowdhary authored May 15, 2020
1 parent 6238fc2 commit 3532513
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,24 @@ import { isUp } from "https://deno.land/x/up/mod.ts";
const result = await isUp("https://google.com"); // true
```

Alternatively, you can use it directly from the CLI:

```bash
deno run --allow-net https://deno.land/x/up/mod.ts https://google.com
```

You can also install it globally using the following:

```bash
deno install --allow-net -n up https://deno.land/x/up/mod.ts
```

Then, the package is available to run:

```bash
up https://google.com # Result: https://google.com is up
```

Required permissions:

1. `--allow-net`
Expand Down

0 comments on commit 3532513

Please sign in to comment.