diff --git a/README.md b/README.md new file mode 100644 index 0000000..1919a12 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# PiggyBackpacks [![Poggit-CI](https://poggit.pmmp.io/ci.badge/DaPigGuy/PiggyBackpacks/PiggyBackpacks/master)](https://poggit.pmmp.io/ci/DaPigGuy/PiggyBackpacks) +PiggyBackpacks adds backpacks (portable chests) to your server with custom bag recipes and varying sizes. + +## Information +* We do not support any spoons. Anything to do with spoons (Issues or PRs) will be ignored. +* We are using the [InvMenu](https://github.com/Muqsit/InvMenu) virion. + * In other words, you must use the pre-compiled phar from [Poggit-CI](https://poggit.pmmp.io/ci/DaPigGuy/PiggyBackpacks/~) instead of GitHub. + * If you wish to run it via source, check out [DEVirion](https://github.com/poggit/devirion). +* Need help? Check out our configuration documentation at [PiggyDocs](https://piggydocs.aericio.net/PiggyBackpacks.html). +* Check out our [Discord Server](https://discord.gg/qmnDsSD) for additional plugin support.