feat(docs): update with screenshot and badge

mistweaverco · Jan 28, 2025 · 3e81380 · 3e81380
1 parent 1b1db24
commit 3e81380
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,13 +1,36 @@
+<div align="center">
+
+![Retro Terminal Logo](assets/logo.svg)
+
 # retro-theme.terminal
 
+[![Made with love](assets/badge-made-with-love.svg)](https://mistweaverco.com)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/mistweaverco/retro-theme.terminal?style=for-the-badge)](https://github.com/mistweaverco/kulala.nvim/releases/latest)
+
+[Install](#install) • [Configuration](#configuration) 
+
+<p></p>
+
 A simple, yet beautiful kitty terminal theme.
 
+<p></p>
+
+![screenshot](assets/screenshot.jpg)
+
+<p></p>
+
+</div>
+
+## Install
+
 ```sh
 git clone [email protected]:mistweaverco/retro-theme.terminal.git /tmp/retro-theme.terminal
 mkdir -p $HOME/.config/kitty/themes/retro-theme
 cp -pr /tmp/retro-theme.terminal/.config/kitty/* $HOME/.config/kitty/themes/retro-theme
 ```
 
+## Configuration
+
 Add this to your kitty config:
 
 ```

diff --git a/assets/badge-made-with-love.svg b/assets/badge-made-with-love.svg
diff --git a/assets/logo.svg b/assets/logo.svg
diff --git a/assets/screenshot.jpg b/assets/screenshot.jpg