From eef8fec21fbfbdfbb2301850de18e1ec57db3eb7 Mon Sep 17 00:00:00 2001
From: Wiktor Zykubek <dev@wzykubek.xyz>
Date: Fri, 27 Dec 2024 04:47:24 +0100
Subject: [PATCH] docs: add README.md file

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bee7c13
--- /dev/null
+++ b/README.md
@@ -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
+```