wzykubek/licensmith
1
0
Fork 0
Code Issues Wiki

docs: add README.md file

Browse Source
This commit is contained in:
Wiktor Zykubek 2024-12-27 04:47:24 +01:00
parent 113033a32d
commit eef8fec21f
Signed by: wzykubek
GPG Key ID: 2221881F957D89B9
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md Normal file
View File

@ -0,0 +1,21 @@
# Licensmith
Effortlessly craft the perfect LICENSE for your Git repo in seconds with a single command!
## 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
```
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"
```
To list available templates run:
```bash
licensmith --list
```