Skip to content

Commit

Permalink
Added documentation section to the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
skiwi2 committed Jan 4, 2015
1 parent f2b0c47 commit 6542543
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,21 @@ HearthMonitor
A monitoring tool for the game HearthStone.

Concept
--------
-------

The concept of HearthMonitor is to read a logfile from HearthStone and offer the ability to analyze that logfile, it also has the ability to work in real-time. For the real-time visualization there is an Android app that will visualize data in real-time.

Structure
--------
---------

HearthMonitor is split up in multiple components, which can all be found in their own libraries.

1. **The log API**: A format that describes how the log entries look like and how they are stored. It can be found at https://github.com/skiwi2/HearthMonitor-LogAPI.
2. **The log reader implementation**: A log reader implementation that can be used to read logfiles with. It can be found at https://github.com/skiwi2/HearthMonitor-LogReader.
3. **The Android app**: An Android app to visualize data from the logfiles. It can be found at https://github.com/skiwi2/HearthMonitor-AndroidApp.
4. **The HearthMonitor application**: The HearthMonitor application itself can be found in this repository. It will read the logfiles and offer ways to communicate with the apps.
4. **The HearthMonitor application**: The HearthMonitor application itself can be found in this repository. It will read the logfiles and offer ways to communicate with the apps.

Documentation
-------------

- [User Requirements Document](https://github.com/skiwi2/HearthMonitor/wiki/User-Requirements-Document)

0 comments on commit 6542543

Please sign in to comment.