From 45f0eb8bab525be84de12bf806cd6ed3058153f6 Mon Sep 17 00:00:00 2001 From: 4n0n <4n0n@tinkr.anon> Date: Sat, 31 Dec 2022 19:45:19 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 20da9a5..b1c71f0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ -# bastion -Bastion is a heavily cached World of Warcraft scripting platform +Bastion aims to be a highly performant and complete World of Warcraft data visualization layer, as such developers may +leverage it to create combat rotations, gathering bots, quest bots, and much more! + +Pull requests are welcome and encouraged, however I do ask that scripts such as rotations live in their own repository, +for the moment the included restoration druid rotation is the exception as it serves as a learning resource for developers +to reference in creating their own scripts. + +Feel free to browse around the [Wiki](https://git.tinkr.site/4n0n/bastion/wiki) or just start by reading the code! + +## Quick Start +- [Download](https://git.tinkr.site/4n0n/bastion/archive/main.zip) or clone the repository. +- Move the bastion folder to your `Tinkr/scripts` folder. +- Once in-game type `/bastion toggle` to enable the engine. \ No newline at end of file