From 9b473a14a3425854760f6e3011ac98b2f1532987 Mon Sep 17 00:00:00 2001 From: Drew Youngwerth Date: Fri, 9 Nov 2018 16:38:02 -0700 Subject: [PATCH] Add demo to README --- README.md | 5 +++++ demo.svg | 1 + src/example.ts | 2 +- 3 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 demo.svg diff --git a/README.md b/README.md index d07c488..919323d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + +

+ +

+ # Cliffy - A Framework For Interactive CLIs Cliffy is a simple, powerful utility for making interactive command line interfaces. diff --git a/demo.svg b/demo.svg new file mode 100644 index 0000000..25acd5d --- /dev/null +++ b/demo.svg @@ -0,0 +1 @@ +❯nodedist/example.jsserverconsole->hserverconsole->heserverconsole->helserverconsole->helpCliffyExampleCLI-2.0.0ThisisanexampleCLI.MadewithCliffyUsage:<cmd>Availablecommands:help<cmd>add[options]Addsomethingtotheserverdatabasestart[options]Starttheserverstop[options]Stoptheserverbind[options]<address>Bindtheservertoanewaddressserverconsole->serverconsole->helpaserverconsole->helpadserverconsole->helpaddAddsomethingtotheserverdatabaseadd[options]Sub-Commands:user[options]<name>Addausertothedatabasegroup[options]<name>Addagrouptothedatabaseserverconsole->helpadduserAddausertothedatabaseadduser[options]<name>Options:@adminTheuserisanadminserverconsole->aserverconsole->adserverconsole->addserverconsole->addiserverconsole->addisserverconsole->addiseserverconsole->addiserserverconsole->adduserverconsole->addusserverconsole->adduseserverconsole->adduserserverconsole->adduserdrewUserdrewaddedserverconsole->adduser@adminserverconsole->adduser@adminalexAdminuseralexaddedserverconsole->bindserverconsole->bind0.0.0.0Serverboundto0.0.0.0serverconsole->sserverconsole->stserverconsole->startServerstarted!serverconsole->stop~/projects/cliffydevelop*41s❯serverconsole->he;serverconsole->helpadduserverconsole->helpaddusserverconsole->helpadduseserverconsole->adduserdserverconsole->adduserdrserverconsole->adduserdreserverconsole->adduser@serverconsole->adduser@aserverconsole->adduser@adserverconsole->adduser@admserverconsole->adduser@admiserverconsole->adduser@adminaserverconsole->adduser@adminalserverconsole->adduser@adminaleserverconsole->bserverconsole->biserverconsole->binserverconsole->bind0serverconsole->bind0.serverconsole->bind0.0serverconsole->bind0.0.serverconsole->bind0.0.0serverconsole->bind0.0.0.serverconsole->staserverconsole->starserverconsole->sto \ No newline at end of file diff --git a/src/example.ts b/src/example.ts index ce7ac59..4a5db9e 100644 --- a/src/example.ts +++ b/src/example.ts @@ -4,7 +4,7 @@ const cli = new CLI(); cli .setName("Cliffy Example CLI") - .setVersion(require(`${__dirname}/../package.json`).version) + .setVersion("2.0.0") .setInfo("This is an example CLI. Made with Cliffy") .setDelimiter("server console -> ") .addCommand("add", {