From 4ac2d40d95ada7323dea2fdfd2c1e9de78581fa2 Mon Sep 17 00:00:00 2001
From: Sahaj Jain <82111591+jnsahaj@users.noreply.github.com>
Date: Wed, 30 Oct 2024 12:40:28 +0530
Subject: [PATCH] Update README.md

---
 README.md | 28 ++++++++++++++++++++++++++--
 1 file changed, 26 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 02a5e36..586e105 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,28 @@
 # lumen
-CLI tool to explain/summarise git commits
+[WIP] Free and open-source CLI tool to summarise git commits using AI
 
-Work in progress - stay tuned!
+Supports OpenAI, Phind, and Groq
+
+## Installation
+
+### Cargo
+
+```bash
+cargo install lumen
+```
+
+## Usage
+
+```sh
+$ lumen --help
+$ lumen explain <commit-sha> # eg: lumen explain HEAD
+$ lumen list # requires: fzf
+```
+Default model: `phind`
+
+To use a different model
+```sh
+$ lumen --provider="openai" --api-key="<your-api-key>" explain HEAD
+$ lumen --provider="openai" --api-key="<your-api-key>" list
+```
+You can also set `LUMEN_AI_PROVIDER` and `LUMEN_API_KEY` env variables and use `lumen` commands without specifying `provider`