Fixed REAME

.github/ISSUE_TEMPLATE/sweep-template.yml

@@ -0,0 +1,15 @@
+name: Sweep Issue
+title: 'Sweep: '
+description: For small bugs, features, refactors, and tests to be handled by Sweep, an AI-powered junior developer.
+labels: sweep
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Details
+      description: Tell Sweep where and what to edit and provide enough context for a new developer to the codebase
+      placeholder: |
+        Unit Tests: Write unit tests for <FILE>. Test each function in the file. Make sure to test edge cases.
+        Bugs: The bug might be in <FILE>. Here are the logs: ...
+        Features: the new endpoint should use the ... class from <FILE> because it contains ... logic.
+        Refactors: We are migrating this function to ... version because ...

README.md

@@ -13,19 +13,22 @@ TikTok Live allows you to connect your TikFinity account to Minecraft to perform
 - Add change gift-actions (for example commands, messages, actionbars, teleportations, ...)
 - AntiSpam
 
-**How to install:**
-**1.** Click on this webpage on Download Now and open your Downloads folder
-**2.** Open your Minecraft-Server-Folder and put the plugin from your Downloads in your plugins folder of your Minecraft-Server
-**3.** Start/Restart your server
-**4.** After your server got started the plugin should get activated. Type /plugins in your Console to see if the plugin is working (In the List which get printed out you should see a plugin named "TikTokLive").
-(**5.** Open your TikTokLive folder which can be found in the plugins folder of you Minecraft-Server and open the config.yml. There you can change all settings how you want them)
-**6.** Login/Register at TikFinity and click on "Actions & Events" at the left bar
-**7.** Type /tiktoklive generate as a player with OP-Permissions or console. Now a link should be displayed. Click on the link and click on the button "Copy to clipboard"
-**8.** On the opened TikFinity website click on "Create new Action", type in a name (it isn't important which is the name) and scroll down to "Trigger Webhook". Enable this setting with one click on the box and paste in the copied link (from Minecraft) in the left textbox.
-**9.** On the webpage scroll down to "Save" and Click the Button
-**10.** You can now define "Events" and configure them to execute a Minecraft-Gift-Action!'
-**11.** You're ready! All you need to do is changing the gifts/actions in the config.yml to your preferences. If you need help feel free to ask on my discord: [https://discord.gg/8QWmU4ebCC](https://discord.tikmc.de/)
-
+<h2>How to install</h2>
+<p>
+  <ol>
+    <li>Click on this webpage on Download Now and open your Downloads folder</li>
+    <li>Open your Minecraft-Server-Folder and put the plugin from your Downloads in your plugins folder of your Minecraft-Server</li>
+    <li>Start/Restart your server</li>
+    <li>After your server got started the plugin should get activated. Type /plugins in your Console to see if the plugin is working (In the List which get printed out you should see a plugin named "TikTokLive").</li>
+    <li>Open your TikTokLive folder which can be found in the plugins folder of you Minecraft-Server and open the config.yml. There you can change all settings how you want them)</li>
+    <li>Login/Register at TikFinity and click on "Actions & Events" at the left bar</li>
+    <li>Type /tiktoklive generate as a player with OP-Permissions or console. Now a link should be displayed. Click on the link and click on the button "Copy to clipboard"</li>
+    <li>On the opened TikFinity website click on "Create new Action", type in a name (it isn't important which is the name) and scroll down to "Trigger Webhook". Enable this setting with one click on the box and paste in the copied link (from Minecraft) in the left textbox.</li>
+    <li>On the webpage scroll down to "Save" and Click the Button</li>
+    <li>You can now define "Events" and configure them to execute a Minecraft-Gift-Action!'</li>
+    <li>You're ready! All you need to do is changing the gifts/actions in the config.yml to your preferences. If you need help feel free to ask on my discord: <a href="https://discord.tikmc.de/" target="_blank">https://discord.gg/8QWmU4ebCC</a>
+  </ol>
+</p>
 **Coming Soon / TODO:**
 - A GUI for a easier setup
 - Edit Code

sweep.yaml

@@ -0,0 +1,35 @@
+# Sweep AI turns bugs & feature requests into code changes (https://sweep.dev)
+# For details on our config file, check out our docs at https://docs.sweep.dev/usage/config
+
+# This setting contains a list of rules that Sweep will check for. If any of these rules are broken in a new commit, Sweep will create an pull request to fix the broken rule.
+rules:
+  - "All new business logic should have corresponding unit tests."
+  - "Refactor large functions to be more modular."
+  - "Add docstrings to all functions and file headers."
+
+# This is the branch that Sweep will develop from and make pull requests to. Most people use 'main' or 'master' but some users also use 'dev' or 'staging'.
+branch: 'main'
+
+# By default Sweep will read the logs and outputs from your existing Github Actions. To disable this, set this to false.
+gha_enabled: True
+
+# This is the description of your project. It will be used by sweep when creating PRs. You can tell Sweep what's unique about your project, what frameworks you use, or anything else you want.
+#
+# Example:
+#
+# description: sweepai/sweep is a python project. The main api endpoints are in sweepai/api.py. Write code that adheres to PEP8.
+description: ''
+
+# This sets whether to create pull requests as drafts. If this is set to True, then all pull requests will be created as drafts and GitHub Actions will not be triggered.
+draft: False
+
+# This is a list of directories that Sweep will not be able to edit.
+blocked_dirs: []
+
+# This is a list of documentation links that Sweep will use to help it understand your code. You can add links to documentation for any packages you use here.
+#
+# Example:
+#
+# docs:
+#   - PyGitHub: ["https://pygithub.readthedocs.io/en/latest/", "We use pygithub to interact with the GitHub API"]
+docs: []