Update README and add travis build badges

kohana · Oct 10, 2014 · 5cc6000 · 5cc6000
1 parent 9bccfec
commit 5cc6000
Showing 1 changed file with 19 additions and 3 deletions.
diff --git a/README.markdown b/README.markdown
@@ -1,13 +1,29 @@
 # Kohana-PHPUnit integration
 
-This module integrates PHPUnit with Kohana.
+| ver   | Stable                                                                                                                               | Develop                                                                                                                                |
+|-------|--------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
+| 3.3.x | [![Build Status - 3.3/master](https://travis-ci.org/kohana/unittest.svg?branch=3.3%2Fmaster)](https://travis-ci.org/kohana/unittest) | [![Build Status - 3.3/develop](https://travis-ci.org/kohana/unittest.svg?branch=3.3%2Fdevelop)](https://travis-ci.org/kohana/unittest) |
+| 3.4.x | [![Build Status - 3.4/master](https://travis-ci.org/kohana/unittest.svg?branch=3.4%2Fmaster)](https://travis-ci.org/kohana/unittest) | [![Build Status - 3.4/develop](https://travis-ci.org/kohana/unittest.svg?branch=3.4%2Fdevelop)](https://travis-ci.org/kohana/unittest) |
+
+This module integrates PHPUnit with Kohana and is used to run all the core Kohana tests. In most cases you will not
+need to use this module for testing your own projects. If there are particular helpers provided here that you rely on,
+that may be a sign that your own code is too closely coupled to the behaviour of the Kohana core classes.
 
 If you look through any of the tests provided in this module you'll probably notice all theHorribleCamelCase.
 I've chosen to do this because it's part of the PHPUnit coding conventions and is required for certain features such as auto documentation.
 
-## Requirements
+## Requirements and installation
+
+Dependencies are listed in the composer.json - run `composer install` to install the module and all external requirements.
+Note that more usually you will add this module to your own module's composer.json:
 
-* [PHPUnit](http://www.phpunit.de/) >= 3.4
+```json
+{
+  "require-dev": {
+    "kohana/unittest": "3.3.*@dev"
+  }
+}
+```
 
 ## Usage