docs: add README.md file
This commit is contained in:
parent
113033a32d
commit
eef8fec21f
21
README.md
Normal file
21
README.md
Normal 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
|
||||||
|
```
|
Loading…
x
Reference in New Issue
Block a user