Skip to content

Commit 1599d43

Browse files
authored
Update README.md
1 parent bf03d5f commit 1599d43

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ The last library you'll ever need for building intuitive, robust and flexible CL
88

99
# Table of contents
1010
- [Installation](#installation)
11+
- [Motivation](#motivation)
1112
- [Basic usage](#basic-usage)
1213
- [Documentation](#documentation)
1314
- [Commands](#commands)
@@ -35,6 +36,20 @@ The last library you'll ever need for building intuitive, robust and flexible CL
3536
npm install cilly
3637
```
3738

39+
# Motivation and features
40+
The `cilly` package takes a lot of inspiration from great packages such as [commander.js](https://github.com/tj/commander.js).
41+
Cilly presents a small set of strong concepts that simplify the processing flow from input to invoking a command handler.
42+
43+
The primary features that separate `cilly` from other libraries are:
44+
1. Separate `parse()` and `process()` methods
45+
2. Option sharing and inheritance between commands and subcommands
46+
3. `onParse()`, `onProcess()` and `validator()` hooks for options and arguments
47+
4. Custom usage documentation
48+
5. Support for generating documentation from command definitions
49+
6. Fully typed
50+
7. Fully tested ![coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/Minibrams/1708995a4933a08f4838df0243926653/raw/cilly__main.json)
51+
52+
3853
# Basic usage
3954
With a file called `build.ts`:
4055
```typescript

0 commit comments

Comments
 (0)