diff --git a/README.markdown b/README.markdown index 92bdcd4..ff1328b 100755 --- a/README.markdown +++ b/README.markdown @@ -1,11 +1,13 @@ -# ShadowCraft +# ShadowCraft-UI ## About -ShadowCraft is a framework for rogue gear, talent, gem, reforge, enchant, glyph, and rotation optimization. The goal is to have a tool that can run as close to entirely clientside as possible. +ShadowCraft is a framework for rogue gear, talent, gem, reforge, enchant, glyph, and rotation optimization. The goal is to have a tool that can run as close to entirely clientside as possible. This project is the UI portion of this system. The current version of the backend engine resides at https://github.com/Fierydemise/ShadowCraft-Engine. Currently, ShadowCraft uses server-side Ruby for Armory/Wowhead data import and distilling into JS files for consumption by the client. +If you are interested in assisting with development on either the UI or engine, look at the [Shadowcraft-VM](https://github.com/timwoj/shadowcraft-vm) project for easy startup. + ## Requirements Requires Ruby 1.9.2, Rails 3, Coffeescript (which means node.js), and MongoDB 1.6+, as well as a browser made this decade. @@ -46,4 +48,4 @@ How To: * Clone this repository * Make your changes and publish to your own GitHub copy of the repository -* Issue a pull request. More information with the pull request is more likely to end up with a merge. \ No newline at end of file +* Issue a pull request. More information with the pull request is more likely to end up with a merge.