diff --git a/README.md b/README.md index 1ea8f55..8a34701 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,30 @@ A fish (shell) theme with a Slavic cat and a rainbow that signifies git status. + +[![Oh My Fish](https://img.shields.io/badge/Framework-Oh_My_Fish-blue.svg?style=flat)](https://github.com/oh-my-fish/oh-my-fish) +[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](/LICENSE) + ![Slavic cat in action](https://github.com/yangwao/theme-slavic-cat/raw/master/screenshot.png) + +## Instalation + +#### Requirements +* [Fish shell](https://github.com/fish-shell/fish-shell) - a smart and user-friendly command line +shell for OS X, Linux, and the rest of the family +* [Oh My Fish](https://github.com/oh-my-fish/oh-my-fish) - The Fishshell Framework + +Once Oh My Fish is installed: + + omf install slavic-cat + [forked from Toaster](https://github.com/oh-my-fish/theme-toaster) + +## Features + + * Minimal look + * Display branch for Git projects + * Git project dirty status indicator *meow* **(R,C,A,U,M,?)** *meow* + * Fish shell vi mode indicator + * Next line prompt