From 3477ad10731a8f4875a8d61358e2d5d5b4fd7900 Mon Sep 17 00:00:00 2001
From: FlorianMichael <60033407+FlorianMichael@users.noreply.github.com>
Date: Fri, 22 Sep 2023 13:56:54 +0200
Subject: [PATCH] added README file

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..63b5e2f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# ViaRewind-Legacy-Support
+[![Build Status](https://github.com/ViaVersion/ViaRewind/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/ViaVersion/ViaRewind/actions)
+[![Discord](https://img.shields.io/badge/chat-on%20discord-blue.svg)](https://viaversion.com/discord)
+
+**Provides additional features for ViaRewind for Paper servers.**
+
+## Information
+
+This is an addon to [ViaRewind](https://github.com/ViaVersion/ViaRewind).
+
+The features of this plugin will never be added to ViaRewind, this is an addon on purpose. 
+
+ViaRewind is a multiplatform (Paper, BungeeCord, Velocity and Sponge) plugin and this plugin is for Paper only! Adding features to ViaRewind, which do not work on all the supported platforms would be too confusing.
+
+Support Status
+-
+While ViaRewind-Legacy-Support will keep getting updates to function with changes to ViaVersion or ViaBackwards, it will likely not receive many bug fixes or additional features anymore.
+
+Releases / Dev Builds
+-
+Dev builds for **all** of our projects are on our Jenkins server:
+
+- **Jenkins**: https://ci.viaversion.com/view/ViaRewind/job/ViaRewind%20Legacy%20Support/
+
+## Installation
+
+Installing this plugin requires nothing more than putting it in your plugins folder. After you started your server once you can also disable/enable certain features in the generated config file. This plugin only works on Spigot. *If you are using ViaRewind on a Proxy, this plugin will not work.*
+
+## Features
+
+- The **Lily Pad** bounding box is being modified. This prevents 1.7.x-1.8.x from glitching if they try to walk over **Lily Pads**.
+- The **Ladder** bounding box is being modified. This prevents 1.7.x-1.8.x from glitching if they try to climb **Ladders**.
+- If a 1.7.x player opens an **Enchantment Table** this plugin takes Lapis Lazuli from his/her inventory and puts it in the **Enchantment Table**.
+- 1.7.x-1.8.x can interact with **Brewing Stands** to add/remove Blaze Powder to/from them.
+- Play block placement and item pickup **sounds** to 1.7.x-1.8.x players.
+- Velocity is applied during **Elytra flight** for players below 1.9.
+- Players below 1.8 bounce on **Slime Blocks**.
+- Makes **AreaEffectClouds** visible for 1.8.x and lower.
+
+Other Links
+-
+**Maven:** https://repo.viaversion.com/
+
+**Issue tracker:** https://github.com/ViaVersion/ViaRewind-Legacy-Support/issues
+
+**List of contributors:** https://github.com/ViaVersion/ViaRewind-Legacy-Support/graphs/contributors