Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
matthunz authored Jun 16, 2024
1 parent 7466513 commit 40ca64b
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
![Demo](https://github.com/matthunz/prompt/blob/main/demo.png?raw=true)

A shell prompt with infinite customization.

## Features
- Extensible: Configure your prompt with a Haskell domain specific language (eDSL)
- High performance: Your prompt runs in parallel with traditional compiled Haskell
- Easy to use: Don't worry about monads if you don't want, just copy a config and get going

## Installation

By default the CLI will follow the [XDG](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) specification
Expand Down Expand Up @@ -53,3 +60,9 @@ Finally, you can install the CLI with:
```
stack install
```

## Usage
You can recompile your configuration by running:
```
prompt --recompile
```

0 comments on commit 40ca64b

Please sign in to comment.