📝 update readme

EnigmaticaModpacks · Mar 26, 2022 · f99f87a · f99f87a
1 parent 62ae801
commit f99f87a
Showing 1 changed file with 16 additions and 19 deletions.
diff --git a/.github/README.md b/.github/README.md
@@ -1,13 +1,18 @@
-# Modpack Uploader
+# ⏫ Modpack Uploader
 
-Modpack Uploader is a tool designed to automate uploading of modpacks to CurseForge.
-
-It creates a modpack manifest, which is then posted along with metadata to CurseForge for upload.
-When the upload has completed, server files are attached which are generated from the tool.
+Modpack Uploader is a script that can automatically upload modpacks to CurseForge.
 
 Almost everything can be toggled on/off in the settings.
 
-✔️ Features:
+# 🚧 Getting Started
+
+1. Download the latest release, and unzip it into your modpack instance.
+   - You can place it in a subfolder, but you need to change the `$INSTANCE_ROOT` in the `settings.ps1` file.
+2. Fill in the `settings.ps1` file with your modpack information.
+3. Fill in the `secrets.ps1` file with your CurseForge Upload API Token.
+4. Run the `modpack-uploader.ps1` when you're ready to upload your modpack.
+
+# ✔️Features
 
 - Client ZIP file creation and upload with the `CLIENT_FILE_MODULE` and `MODPACK_UPLOADER_MODULE` ✔️ On by default
 - Server ZIP file creation and upload with the `SERVER_FILE_MODULE` and `MODPACK_UPLOADER_MODULE` ✔️ On by default
@@ -16,15 +21,7 @@ Almost everything can be toggled on/off in the settings.
 - Make a modlist complete with links to the mods and authors with the `MODLIST_CREATOR_MODULE` ✔️ _On by default_
 - Make a new GitHub release when you upload your modpack with the `GITHUB_RELEASE_MODULE` ❌ _Off by default_
 
-## Getting Started
-
-1. Download the latest release, and unzip into your modpack instance.
-   - You can place it in a subfolder, but you need to change the `$INSTANCE_ROOT` in the `settings.ps1` file.
-2. Fill in the `settings.ps1` file with your modpack information.
-3. Fill in the `secrets.ps1` file with your CurseForge Upload API Token.
-4. Run the `modpack-uploader.ps1` when you're ready to upload your modpack.
-
-## Dependencies
+# ➕ Dependencies
 
 - [cURL](https://curl.haxx.se/download.html)
 - [7-Zip](https://www.7-zip.org/download.html)
@@ -33,10 +30,10 @@ Almost everything can be toggled on/off in the settings.
   - [Linux Download Instructions](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-linux)
   - [Mac Download Instructions](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-macos)
 
-### Special Thanks
+# ❤️ Special Thanks
 
-[TheRandomLabs](https://github.com/TheRandomLabs), for their [Changelog Generator](https://github.com/TheRandomLabs/ChangelogGenerator), which allows this project to incoorperate the changelogs of the mods that are updated.
+- [TheRandomLabs](https://github.com/TheRandomLabs), for their [Changelog Generator](https://github.com/TheRandomLabs/ChangelogGenerator), which allows this project to incoorperate the changelogs of the mods that are updated.
 
-[CrankySupertoon](https://github.com/CrankySupertoon), for her help in improving this tool while making it easier to use.
+- [CrankySupertoon](https://github.com/CrankySupertoon), for her help in improving this tool while making it easier to use.
 
-[ModdingX](https://github.com/ModdingX) for their project [Modlist Creator](https://github.com/ModdingX/ModListCreator), which allows this project to create nice looking modlists.
+- [ModdingX](https://github.com/ModdingX) for their project [Modlist Creator](https://github.com/ModdingX/ModListCreator), which allows this project to create nice looking modlists.