Added a readme

readme.md

@@ -0,0 +1,80 @@
+# Hot Experience
+
+## Introduction
+
+Hot Experience is a Minecraft mod designed to make inventory management easier by enabling quick swaps between Experience Bottles and Totems of Undying. With this mod, you can efficiently toggle between these two items using a configurable key binding, enhancing your gameplay experience.
+
+## Features
+
+- **Toggle Between Items**: Easily swap Experience Bottles and Totems of Undying in your offhand.
+- **Configurable Key Binding**: Set your preferred key to trigger the swap.
+- **Compatibility**: Works with the latest versions of Minecraft.
+
+## Installation
+
+### For Minecraft Fabric
+
+1. **Install Fabric**:
+    - Download and install the [Fabric Installer](https://fabricmc.net/use/).
+    - Run the installer and select the correct Minecraft version.
+
+2. **Install Fabric API**:
+    - Download the latest version of [Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api) and place it in your Minecraft `mods` folder.
+
+3. **Download Hot Experience**:
+    - Download the latest release of Hot Experience from the [GitHub Releases Page](https://github.com/SaolGhra/Hot-Experience/releases).
+
+4. **Place the Mod**:
+    - Place the downloaded `.jar` file into your Minecraft `mods` folder.
+
+5. **Launch Minecraft**:
+    - Open the Minecraft Launcher and select the Fabric profile.
+    - Start the game.
+
+## Usage
+
+1. **Key Binding**:
+    - The default key binding can be configured in Minecraft's controls settings under the `Hot Experience` category.
+    - Use the configured key to toggle between Experience Bottles and Totems of Undying in your offhand.
+
+2. **Functionality**:
+    - When the key is pressed, the mod will check if you have either an Experience Bottle or a Totem of Undying in your inventory.
+    - If the offhand is empty, it will swap in the available item.
+    - If the offhand contains an Experience Bottle, it will swap in a Totem of Undying if available, and vice versa.
+
+## Contributing
+
+If you'd like to contribute to Hot Experience, please follow these steps:
+
+1. **Fork the Repository**:
+    - Click the "Fork" button at the top-right of this page.
+
+2. **Clone Your Fork**:
+    - Use `git clone <your-fork-url>` to clone your fork to your local machine.
+
+3. **Create a Branch**:
+    - Create a new branch for your changes: `git checkout -b <your-branch-name>`.
+
+4. **Make Changes**:
+    - Implement your changes or new features.
+
+5. **Commit and Push**:
+    - Commit your changes: `git commit -am 'Add new feature'`.
+    - Push your branch: `git push origin <your-branch-name>`.
+
+6. **Submit a Pull Request**:
+    - Go to the repository on GitHub and submit a pull request with a description of your changes.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Credits
+
+- **Developer**: [SaolGhra](https://github.com/SaolGhra)
+
+## Support
+
+For support or issues, please open an issue on the [GitHub Issues](https://github.com/SaolGhra/Hot-Experience/issues) page.
+
+Happy modding!