feat: v2.0.0!

Author: devnote-dev

README.md

@@ -1,29 +1,44 @@
 # CLI.cr
-Yet another Crystal command line interface library.
+
+Yet another command line interface library for Crystal. Based on [spf13/cobra](https://github.com/spf13/cobra), CLI.cr is built to be almost entirely modular, giving you absolute control over almost everything - there isn't even a default help command or flag!
 
 ## Installation
+
 1. Add the dependency to your `shard.yml`:
 ```yaml
 dependencies:
   cli:
     github: devnote-dev/cli.cr
+    branch: stable
 ```
 
 2. Run `shards install`
 
 ## Usage
+
 ```crystal
 require "cli"
 
 class MainCmd < CLI::Command
-  def setup
+  def setup : Nil
     @name = "greet"
-    @description = "Greets a person"
+    description = "Greets a person"
     add_argument "name", desc: "the name of person to greet", required: true
-    add_option "caps", short: "c", desc: "greet with capitals"
+    add_option 'c', "caps", desc: "greet with capitals"
+    add_option 'h', "help", desc: "sends help information"
+  end
+
+  def pre_run(args, options)
+    if options.has? "help"
+      puts help_template # generated using CLI::Formatter
+
+      false
+    else
+      true
+    end
   end
 
-  def execute(args, options) : Nil
+  def run(args, options) : Nil
     msg = "Hello, #{args.get("name")}!"
 
     if options.has? "caps"
@@ -34,23 +49,21 @@ class MainCmd < CLI::Command
   end
 end
 
-app = CLI::Application.new
-app.add_command MainCmd, default: true
+main = MainCmd.new
+main.execute ARGV
+```
 
-app.run ARGV
 ```
-```shell
 $ crystal greet.cr -h
-Greets a person
-
 Usage:
         greet <arguments> [options]
 
 Arguments:
-        person    the person to greet
+        name    the name of person to greet (required)
 
 Options:
         -c, --caps  greet with capitals
+        -h, --help  sends help information
 
 $ crystal greet.cr Dev
 Hello, Dev!

shard.yml

@@ -1,6 +1,6 @@
 name: cli
 description: expandable command line interface library
-version: 1.0.0
+version: 2.0.0
 crystal: 1.5.0
 
 repository: https://github.com/devnote-dev/cli.cr

src/cli.cr

@@ -1,5 +1,5 @@
 require "./cli/*"
 
 module CLI
-  VERSION = "0.1.0"
+  VERSION = "2.0.0"
 end