From 7ad1d346f6be5c63ac7005ba28d4c7d93a1c3150 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Brala?= <bjorn@swis.nl>
Date: Tue, 14 Jun 2016 17:28:25 +0200
Subject: [PATCH] Add README

---
 README.MD | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 README.MD

diff --git a/README.MD b/README.MD
new file mode 100644
index 0000000..3261872
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,51 @@
+# Game of Tests
+
+[![Build Status](https://travis-ci.org/swisnl/game-of-tests.svg?branch=master)](https://travis-ci.org/swisnl/game-of-tests)
+
+This package serves as a way to search through git repositories and find 
+PHP tests.
+
+## How to use
+
+### Remote
+
+You can inspect a remote repository as follows. This will create a local
+repository in the path specifiek in ``\Swis\GoT\Settings`` and use that 
+to find the tests and test owners.
+
+```php
+$inspector = new \Swis\GoT\Inspector();
+$repository = $inspector->getRepositoryByUrl('git@github.com:swisnl/game-of-tests.git');
+$results = $inspector->inspect($repository);
+```
+
+### Local
+
+If you have a local repository, you can also use that directly, for 
+example if you have a set of base repositories as backups, that it fine.
+
+```php
+$inspector = new \Swis\GoT\Inspector();
+$repository = $inspector->getRepositoryByPath('/path/to/repos');
+$results = $inspector->inspect($repository);
+```
+
+### Settings
+
+You can use the ``\Swis\GoT\Settings`` class to set some settings for the
+package. It lists the available parsers, some paths that are skipped by
+default and the path where the remote repositories are stored localy.
+  
+## Parsers
+  
+There are currently 3 parsers defined. PhpUnit, Codeception and Behat. A
+parser is a small class that defines how to find files that are tests, 
+and how to count tests for that type.
+
+A parser return an array with ``Swis\GoT\Result`` objects that contain
+the information on the test.
+
+## Example command
+
+The repository includes a small example command for Laravel, should you
+want to want to use it there.