~zethra/license

b1dee4d327731fced64f8870386d89e3acc72a29 — Ben Aaron Goldberg 26 days ago 75dd403
Updated readme
1 files changed, 26 insertions(+), 10 deletions(-)

M README.md
M README.md => README.md +26 -10
@@ 16,16 16,22 @@ selected license into a file called `LICENSE` in the current directory.
## Usage

```text
usage: license <cmd>

Commands:
    list                                   list available licenses
    text   <license name>                  output the text of a license
    header <license name> [comment string] output the header for the given license
                                           if a comment string is included it'll
                                           be appended to the beginning of every
                                           line e.g. '#' or '//'
    help                                   print this message
license 1.0.0
A cli tool to easily add a license to your project

USAGE:
    license [FLAGS] <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information
    -v, --verbose    Print addition debugging information

SUBCOMMANDS:
    header    Print the header text for a license
    help      Prints this message or the help of the given subcommand(s)
    list      List available license names
    text      Print the text of a license
```

## Available Licenses


@@ 78,3 84,13 @@ If you'd like to add I license please add a file named the license's name
containing the content of the license.  If the license has a header that
goes with it also add a file called `<license name>-header` containing the
content of the header.

If the license has fields in it please add template strings for them.  The
template strings are in the format `{{field_name}}`.  The currently support
template items are:

- copyright_year
- author
- project_name
- description