Added Readme.md

README.md

@@ -0,0 +1,41 @@
+# Readme
+Create Pleroma App is a simple python3 script to generate OAuth tokens for your Pleroma account.
+
+By default it will output your credentials as valid python code, but you can disable this with the --plain switch.
+
+## Installing
+To setup the python3 environment (for Arch Linux) run the following commands:
+
+```
+sudo pacman -Syu
+sudo pacman -S --needed python git
+git clone 'https://git.yandere.cc/Anon/YandereLewdBot.git'
+cd YandereLewdBot/
+python -m venv venv
+source venv/bin/activate
+pip install --upgrade pip
+pip install -r requirements.txt
+deactivate
+./run.sh -h
+```
+
+If everything worked correctly you should see usage information on Create Pleroma App.
+
+## Default Settings
+If you want to change the default values for the input prompts, you can edit the source code directly in `src/create_app.py`
+
+# Donate
+XMR: 493HynLQA4z71b3j9ZDXRNQudpdFW8GxeBGD8ahRctKn97RRurMVd35DqVqdAdjv68TcXTJWUwm6ee81ujDXGcmtKFixwQk
+
+BAT: [Basic Attention Token](https://basicattentiontoken.org/)
+
+## Encryption
+You can also encrypt your credentials with the encrypt.py module included in the repo. If you choose to use this with your custom bot, you must copy the module to your project's root directory. See below for an example implementation:
+
+```
+def decrypt_settings(self):
+	if self.settings_encrypt["encrypt"] and not self.decrypted and not self.debug_mode:
+		import encryption
+		self.settings_server = encryption.settings_server_decrypt_cfg(self.settings_server, self.settings_encrypt)
+	self.decrypted = True
+```

run.sh

@@ -22,7 +22,7 @@ RUN_DIR="$(dirname "$ABS_PATH")"
 
 # Relative paths to the virtual environment and main.py
 VENV='./venv/bin/activate'
-ENTRY='./create_app.py'
+ENTRY='./src/create_app.py'
 
 # cd into the bot's root path, set up the virtual environment, and run
 cd "$RUN_DIR"