diff --git a/README.md b/README.md index 842517e5..1bddf7ad 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,28 @@ --- -This is very much work in progress, so please don't try to use it just yet! +> ⚠️ This is very much work in progress, so please don't try to use it just yet! + +Starship is a Rust port of the minimalistic, powerful, and extremely customizable prompt [Spaceship ZSH](https://github.com/denysdovhan/spaceship-prompt). + + +## Features + +### Prompt segments + +- [x] Prompt character turns red if the last command exits with non-zero code. +- [x] Current Node.js version(`⬢`). +- [ ] Current Rust version (`𝗥`). +- [ ] Current battery level and status +- [ ] Current Git branch and rich repo status. +- [ ] Indicator for jobs in the background (`✦`). +- [ ] Execution time of the last command if it exceeds the set threshold. + +### Shell support + +- [x] Fish shell +- [ ] Z Shell +- [ ] Bash ## Setup