diff --git a/README.md b/README.md index b0f319e..29a4718 100644 --- a/README.md +++ b/README.md @@ -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 `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 diff --git a/cmd/root.go b/cmd/root.go index 2b890c8..bfca6a4 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -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 LICENSE file for your Git repository with ease, using just one command. This tool is designed to save you time and effort.", } func Execute() { diff --git a/todo.md b/todo.md new file mode 100644 index 0000000..79e3f25 --- /dev/null +++ b/todo.md @@ -0,0 +1,3 @@ +add short summary of each license and it's requirements +add standard license headers if supported +add tests