Merge pull request #8 from bookdude13/dev

Updated readme. Bumped version to 1.0.0

PerformanceMeter/PerformanceMeter/Properties/AssemblyInfo.cs

@@ -36,5 +36,5 @@
 [assembly: AssemblyVersion("0.1.0.0")]
 [assembly: AssemblyFileVersion("1.0.0.0")]
 
-[assembly: MelonInfo(typeof(PerformanceMeter.MainMod), "Performance Meter", "0.1.0", "bookdude13", "https://github.com/bookdude13/SRPerformanceMeter")]
+[assembly: MelonInfo(typeof(PerformanceMeter.MainMod), "Performance Meter", "1.0.0", "bookdude13", "https://github.com/bookdude13/SRPerformanceMeter")]
 [assembly: MelonGame("Kluge Interactive", "SynthRiders")]

README.md

@@ -1,2 +1,25 @@
-# SRPerformanceMeter
-SynthRiders Performance Meter mod inspired by MCJack123's PerformanceMeter BeatSaber mod
+# Synth Riders Performance Meter
+Synth Riders Performance Meter mod inspired by [MCJack123's PerformanceMeter BeatSaber mod](https://github.com/MCJack123/PerformanceMeter).
+
+Adds an additional panel to the end game screen showing the average percentage of your life bar and a graph of the life bar over the course of the song.
+
+More features coming soon!
+
+![End Game Screen](/end_game_example.jpeg "End Game Screen")
+
+
+## Setup
+1. Prepare Synth Riders for the use with mods by following the [installation instructions for [MelonLoader](https://wiki.synthriderz.com/en/guides/installing-mods)
+2. Grab the newest version of SRPerformanceMeter from releases and extract it to ./SynthRiders/Mods (create new directory if it doesn't exist)
+3. Enjoy!
+
+## Technical Detail
+- During gameplay the life bar percentage is polled every 100ms
+
+- Less than 50% life is red, 50-74.99% is orange, 75-89.99% is yellow-green, and 90%+ is green
+
+---
+
+## Disclaimer
+This mod is not affiliated with Synth Riders or Kluge Interactive. Use at your own risk.
+