readme

dxxxxy · Sep 12, 2021 · d43329e · d43329e
1 parent b22d8cf
commit d43329e
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,12 @@
+# LeagueHider
+Hide the league client from desktop, taskbar and mute audio. Coded in C++. <kbd>dxxxxy#5818</kbd>.
+
+## Usage
+Launch the `.exe` (download from [here](https://github.com/DxxxxY/LeagueHider/Releases))
+> The app will sit in the background and wait for user inputs. 
+>> ~10kb file size, ~2mb memory usage, ~0% cpu usage.
+
+### User Inputs
+<kbd>INSERT</kbd> - Toggle for hiding/showing the game's window and muting audio.
+
+<kbd>END</kbd> - Quits the background process and plays a beep sound.