1
0

docs: update README.md

This commit is contained in:
Wiktor Zykubek 2024-12-29 16:58:00 +01:00
parent 9d8e8d03b2
commit f3c5c08dd7
Signed by: wzykubek
GPG Key ID: 2221881F957D89B9

View File

@ -5,19 +5,19 @@ Effortlessly craft the perfect LICENSE for your Git repo in seconds with a singl
## Usage ## Usage
This command will generate ISC `LICENSE` file in your current directory, including current year, and your name read from Git configuration: This command will generate ISC `LICENSE` file in your current directory, including current year, and your name read from Git configuration:
```bash ```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. 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: You can also specify different values using:
```bash ```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: To list available templates run:
```bash ```bash
licensmith --list licensmith list
``` ```
## Installation ## Installation