commit 83c003b2892dc9f004954a1dadf78675b62de569
parent 0241ff5349d6b6c5b623031e6ecc9521d5d7ed65
Author: auth <64337177+authorisation@users.noreply.github.com>
Date: Fri, 7 Jul 2023 18:36:29 +0000
readme: quick start
Diffstat:
1 file changed, 13 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -12,6 +12,19 @@ Please note that this project is currently in development, so bugs and crashes m
To Download the latest stable release, please visit the [Releases](https://github.com/rhunk/SnapEnhance/releases) page.<br/>
You can also download the latest debug build from the [Actions](https://github.com/rhunk/SnapEnhance/actions) section.<br/>
We no longer offer official LSPatch binaries for obvious reasons. However, you're welcome to patch them yourself, as they should theoretically work without any issues.
+
+## Quick Start
+Requirements:
+- Rooted using Magisk or KernelSU
+- LSPosed installed and fully functional
+
+Although using this in an unrooted enviroment using something like LSPatch should be working fine, it is not recommended to do so, use at your own risk!
+
+1. Install the module APK from either this [Github repo](https://github.com/rhunk/SnapEnhance/releases) or the [LSPosed repo](https://modules.lsposed.org/module/me.rhunk.snapenhance)
+2. Turn on the module in LSPosed and make sure Snapchat is in scope
+3. Force Stop Snapchat
+4. Open the menu by clicking the [Settings Gear Icon](https://i.imgur.com/2grm8li.png)
+
## Features
<details open>
<summary>Spying & Privacy</summary>
