wzykubek/licensmith
1
0
Fork 0
Code Issues Wiki

docs: update README.md and command description

Browse Source
This commit is contained in:
Wiktor Zykubek 2025-01-04 21:06:23 +01:00
parent 6d98196c43
commit e8fca25011
Signed by: wzykubek
GPG Key ID: 2221881F957D89B9
2 changed files with 30 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -1,39 +1,53 @@
# Licensmith
Effortlessly craft the perfect LICENSE for your Git repo in seconds with a single command!
Crafting the ideal license for your Git repository in seconds!
## Getting Started
Licensmith, a streamlined tool, allows you to create an ISC `LICENSE` file for your Git repository with ease, using just one command. This tool is designed to save you time and effort.
### Usage Instructions
To generate an ISC `LICENSE` file with the current year and your name, run the following 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 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 searches for user details in your local repository (name and email) as a fallback option. It uses global configuration if no local information is found.
You can customize this process by providing specific values using the following command:
You can also specify different values using:
```bash
licensmith add ISC --name "John Doe" --email "jdoe@example.com"
```
To list available templates:
To view available templates, run the following command:
```bash
licensmith list
```
To show license summary:
To display a license summary, use:
```bash
licensmith show ISC
```
## Installation
There are different ways to get Licensmith:
1. Use prebuilt binaries:
- [Releases](https://github.com/wzykubek/licensmith/releases): Stable versions
- [Actions](https://github.com/wzykubek/licensmith/actions): Development versions
## Installation Options
2. Install from source: see [compilation](#compilation) section
Licensmith can be installed using various methods:
1. **Prebuilt Binaries:**
- For stable versions, visit the [Releases](https://github.com/wzykubek/licensmith/releases) page.
- To access development versions, check out the [Actions](https://github.com/wzykubek/licensmith/actions).
2. **Installation from Source:** Refer to the [compilation section](#compilation) for step-by-step instructions.
## Compilation Instructions
To build Licensmith from source, follow these steps:
## Compilation
```bash
git clone https://github.com/wzykubek/licensmith
cd licensmith

4
cmd/root.go
View File

@ -9,8 +9,8 @@ import (
var rootCmd = &cobra.Command{
Use: "licensmith",
Short: "Licensmith is a LICENSE generator",
Long: "Effortlessly craft the perfect LICENSE for your Git repo in seconds with a single command!",
Short: "Crafting the ideal license for your Git repository in seconds!",
Long: "Licensmith, a streamlined tool, allows you to create an ISC `LICENSE` file for your Git repository with ease, using just one command. This tool is designed to save you time and effort.",
}
func Execute() {