mirrors/lumen
1
0
Fork 0
mirror of https://github.com/jnsahaj/lumen.git synced 2025-12-23 05:36:48 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Sahaj Jain 2024-10-31 03:00:19 +05:30 • committed by GitHub
parent d1d758a3b4
commit 93248190d5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 12 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -15,15 +15,23 @@ lumen is a free CLI tool that uses AI to summarise git commits without requiring
| [Phind](https://www.phind.com/agent) `phind` (Default) | No | `Phind-70B` |
## Installation
1. Cargo: `cargo install lumen`
# Installation
### Using [Homebrew](https://brew.sh/) (MacOS and Linux)
```
brew tap jnsahaj/lumen
brew install lumen --formula
```
### Using [Cargo](https://github.com/rust-lang/cargo)
```
cargo install lumen
```
## Prerequisites
# Prerequisites
1. git
2. [fzf](https://github.com/junegunn/fzf) (optional): Required for `lumen list` command
3. [mdcat](https://github.com/swsnr/mdcat) (optional): Required for pretty output formatting
## Usage
# Usage
```zsh
$ lumen --help