wzykubek/licensmith
1
0
Fork 0
Code Issues Wiki

docs: update README.md

Browse Source
This commit is contained in:
Wiktor Zykubek 2024-12-29 16:58:00 +01:00
parent 3e75458760
commit f1f7e62853
Signed by: wzykubek
GPG Key ID: 2221881F957D89B9
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -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