From 353251311a81ec672aafb92716f00963a479900d Mon Sep 17 00:00:00 2001 From: Anand Chowdhary Date: Fri, 15 May 2020 22:21:37 +0530 Subject: [PATCH] :pencil: Add CLI docs --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index a00e3a5..98501fd 100644 --- a/README.md +++ b/README.md @@ -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`