Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wzykubek committed Dec 29, 2024
1 parent 9d8e8d0 commit f3c5c08
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ Effortlessly craft the perfect LICENSE for your Git repo in seconds with a singl
## Usage
This command will generate ISC `LICENSE` file in your current directory, including current year, and your name read from Git configuration:
```bash
licensmith --license ISC
licensmith add ISC
```

By default, Licensmith read your local repository looking for user details (name and e-mail), as a fallback it uses global configuration.

You can also specify different values using:
```bash
licensmith --license ISC --name "John Doe" --email "jdoe@example.com"
licensmith add ISC --name "John Doe" --email "jdoe@example.com"
```

To list available templates run:
```bash
licensmith --list
licensmith list
```

## Installation
Expand Down

0 comments on commit f3c5c08

Please sign in to comment.