From f890cf339899afa2b3e06b82a2a0ce12fdd52b67 Mon Sep 17 00:00:00 2001
From: cxreiff <cooper@cxreiff.com>
Date: Mon, 29 Jul 2024 03:38:26 -0700
Subject: [PATCH] updated README.md, clean tag

---
 Cargo.lock |  2 +-
 Cargo.toml |  2 +-
 README.md  | 36 ++++++++++++++++++++++++++++--------
 3 files changed, 30 insertions(+), 10 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index 303fd45..ee431a0 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -2730,7 +2730,7 @@ dependencies = [
 
 [[package]]
 name = "lifecycler"
-version = "0.2.1"
+version = "0.2.3"
 dependencies = [
  "bevy",
  "bevy_atmosphere",
diff --git a/Cargo.toml b/Cargo.toml
index 535901f..8d32362 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "lifecycler"
 description = "Bevy Game Jam #5 submission. Terminal aquarium."
-version = "0.2.2"
+version = "0.2.3"
 edition = "2021"
 license = "MIT OR Apache-2.0 OR CC0-1.0"
 authors = ["cxreiff <cooper@cxreiff.com>"]
diff --git a/README.md b/README.md
index 0c717e8..0a73367 100644
--- a/README.md
+++ b/README.md
@@ -2,25 +2,42 @@
 
 [_bevy game jam #5 submission_](https://itch.io/jam/bevy-jam-5)
 
-## installation
+![logo](https://assets.cxreiff.com/github/lifecycler.png)
+
+An aquarium that runs in your terminal!
+
+A decoration/fidget-toy that lets you watch your fishes' lifecycle while you code. Test drive of my plugin [bevy_ratatui_render](https://github.com/cxreiff/bevy_ratatui_render).
+
+## play with cargo
 
 If you have [cargo](https://github.com/rust-lang/cargo) installed, you can simply run the following:
 
 ```sh
-cargo install lifecycler
+cargo install lifecycler --locked
 ```
 
-Alternatively you can manually download an executable from the itch.io page.
-
-## play
-
-To launch the game:
+...and then to launch the game:
 
 ```sh
 lifecycler
 ```
 
-If you manually installed the executable, you will have to include the path (e.g. `./lifecycler` if in the same directory).
+## controls
+
+|                    |                            |
+|--------------------|----------------------------|
+| Left Click or Drag | Dispense a food pellet.    |
+| Right click        | $80                        |
+| M                  | Mute/unmute sound effects. |
+| Q                  | Quit the game.             |
+
+## manual installation
+
+Alternatively you can manually download an executable from the [itch.io page](https://cxreiff.itch.io/lifecycler) or [github releases](https://github.com/cxreiff/lifecycler/releases).
+
+If you manually installed the executable, you will have to include the path to launch it (e.g. `./lifecycler` if in the same directory).
+
+On macOS you may need to Right-Click > Open With, selecting a supported terminal, and then selecting Open in order to bypass code signing (I haven't figured out code signing yet).
 
 ## compatibility
 
@@ -36,3 +53,6 @@ This includes a decent variety of terminals, but I have personally confirmed goo
 - WezTerm
 - iTerm2
 
+## gifs
+
+![day mode](https://assets.cxreiff.com/github/lifecycler_day.gif)![night mode](https://assets.cxreiff.com/github/lifecycler_night.gif)