Skip to content

Commit

Permalink
Add info about engine and vm projects to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Tim Wojtulewicz committed Jul 29, 2015
1 parent 23f8d54 commit 7efea28
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions 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.
Expand Down Expand Up @@ -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.
* Issue a pull request. More information with the pull request is more likely to end up with a merge.

0 comments on commit 7efea28

Please sign in to comment.