diff --git a/tools/quick-e2e/README.md b/tools/quick-e2e/README.md index 5d5bea08..b37ed3f4 100644 --- a/tools/quick-e2e/README.md +++ b/tools/quick-e2e/README.md @@ -1,5 +1,9 @@ # Quick E2E environment setup +A tool to generate a new E2E environment for Minecraft servers. Can be used to quickly setup a new environment for testing plugins on multiple server types and versions. + +In the future, this tool can also be using in a CI/CD pipeline to automatically run tests on new builds or plugin versions. + ## TODOs - [ ] Add system to load configuration from file / command line arguments