docs: Update readme

WEGFan · Jan 10, 2022 · 9282de2 · 9282de2
1 parent db51e02
commit 9282de2
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,26 @@
 # Trailine
+
+![Preview](assets/preview-prologue.png)
+
+---
+
+This mod allows you to customize Madeline's trails, including frequency, duration, opacity, and more.
+
+Three trail types are supported:
+
+- Hair Color: The trail's color will follow Madeline's hair, like the playback ghosts in Farewell.
+  ![Trail Type - Hair Color](assets/hair-color.png)
+- [Onion Skin](https://en.wikipedia.org/wiki/Onion_skinning): The trail will use Madeline's sprite instead of an outline with color.
+  ![Trail Type - Onion Skin](assets/onion-skin.png)
+- Pattern: The trail's color will follow the current pattern in mod options.
+  ![Trail Type - Pattern](assets/pattern.png)
+
+Settings:
+
+![Settings preview](assets/settings.png)
+
+## Installing
+
+You can download the latest version on [GameBanana](https://gamebanana.com/mods/349341) or [GitHub releases](https://github.com/WEGFan/Celeste-Trailine/releases).
+
+[Everest](https://everestapi.github.io/) is required to enable modding for Celeste.
diff --git a/assets/hair-color.png b/assets/hair-color.png
diff --git a/assets/onion-skin.png b/assets/onion-skin.png
diff --git a/assets/pattern.png b/assets/pattern.png
diff --git a/assets/preview-prologue.png b/assets/preview-prologue.png
diff --git a/assets/settings.png b/assets/settings.png