Merge pull request #11 from lokesh-coder/develop

Deps update

Author: lokesh-coder

README.md

@@ -1,28 +1,97 @@
 # Lesy JS
 
-Lesy js is a flexible lightweight CLI framework to build modern command line apps without too much boilerplate.
+Lesy js is a super simple CLI framework to build modern node based command line applications, without much boilerplate.
 
-If you have already used commander, yargs, gluegun, then lesy js will definitely give you a new experience and you will feel the difference.
+Though there were awesome tools available for building CLI apps, the ultimate and only purpose of Lesy is to bring all cool fuctionalities to UI. Which means write code once and run it in terminal or web UI. There were other nice features in lesy that you might like.
 
-### Why LesyJS
+<br/>
 
-- **Language**: Full support for Typescript with @types
+### 𝙵𝚎𝚊𝚝𝚞𝚛𝚎𝚜
 
-- **Boilerplate**: Write less code. whether its a dead simple project or complex one.
+✓ **Language**: Javascript and Typescript with @types
 
-- **Flexibility**: Able to change complete behaviour with middlewares
+✓ **Flexibility**: Able to change complete behaviour with middlewares
 
-- **Extensions**: Add cool functionalities with plugins
+✓ **Boilerplate**: Write less code. whether its a dead simple project or complex one.
 
-- **Platform**: Write once and run in CLI or UI
+✓ **Extensions**: Add cool functionalities with plugins
 
-- **Performance**: It is just faster than existing libraries. Benchmark inside.
+✓ **Platform**: Write once and run in CLI or web UI. Desktop interface is coming soon.
 
-- **Testing**: Dedicated testing setup for unit test and integration test
+✓ **Performance**: It is faster than existing tools. Benchmarks inside.
 
-- **Lot more**: Features, sub commands, existing plugins, Boilerplate generator...
+✓ **Testing**: Dedicated testing setup for unit test and integration test
 
-### Try Lesy before installing
+✓ **Lot more**: Features, sub commands, plugins, boilerplate generator...
+
+<br/>
+
+### 𝙸𝚗𝚜𝚝𝚊𝚕𝚕𝚊𝚝𝚒𝚘𝚗
+
+Scaffold new project directly using npx command
+
+```shell
+npx lesy new my-cli
+```
+
+Or, you can install lesy cli globally and generate a new project
+
+```shell
+npm i -g lesy
+lesy new my-cli
+```
+
+Also you can create your own project setup and run lesy. [Learn more](/).
+
+<br/>
+
+### 𝚁𝚞𝚗 𝚌𝚘𝚖𝚖𝚊𝚗𝚍𝚜
+
+Once you setup a project, you can create and run your first command.
+
+```js
+#!/usr/bin/env node
+
+const lesy = require("@lesy/compiler");
+const helloCommand = { name: "hello", run: () => console.log("hello world") };
+
+lesy({ commands: [helloCommand] }).parse();
+```
+
+```
+./bin/cmd hello
+```
+
+It is just a tiny bit of lesy. There are lot of other cool stuffs like, advance commands, middlewares, features, configs, and plugins. [Learn more](/)
+
+<br/>
+
+### 𝙰𝚟𝚊𝚒𝚕𝚊𝚋𝚕𝚎 𝚘𝚏𝚏𝚒𝚌𝚒𝚊𝚕 𝙿𝚕𝚞𝚐𝚒𝚗𝚜
+
+**@lesy/lesy-plugin-pilot**
+Run comamnds in Web UI. Supports input, console, workspace and more..
+
+**@lesy/lesy-plugin-store**
+Key value storage in the system
+
+**@lesy/lesy-plugin-config**
+Setup config files like myapp.config.json, myapp.config.yml, myapp.config.js
+
+**@lesy/lesy-plugin-generator**
+Scaffold projects with handlebars templating
+
+**@lesy/lesy-plugin-prompt**
+Wrapper around inquirer plugin for prompts and questions
+
+**@lesy/lesy-plugin-help**
+Automatically generate beautiful help with sub commands support. Highly customizable
+
+**@lesy/lesy-plugin-validator**
+Prompt if required args are not supplied
+
+<br/>
+
+### 𝚃𝚛𝚢 𝙻𝚎𝚜𝚢 𝙿𝚒𝚕𝚘𝚝 𝚋𝚎𝚏𝚘𝚛𝚎 𝚒𝚗𝚜𝚝𝚊𝚕𝚕𝚒𝚗𝚐
 
 We have a setup a _playground_ for you to play around with it.
 

benchmark/benchmark.suite.js

@@ -27,5 +27,5 @@ b.suite(
   b.cycle(),
   b.complete(),
   b.save({ file: "perf", version: "1.0.0", folder: "./results" }),
-  b.save({ file: "perf", format: "chart.html", folder: "./results" })
+  b.save({ file: "perf", format: "chart.html", folder: "./results" }),
 );