Updated documentation

README.md

@@ -1,11 +1,15 @@
 # Codeception Drupal Module
 
-[![Build Status](https://travis-ci.org/Chapabu/codeception-module-drupal.svg?branch=master)](https://travis-ci.org/Chapabu/codeception-module-drupal)
-[![Coverage Status](https://coveralls.io/repos/Chapabu/codeception-module-drupal/badge.svg?branch=master)](https://coveralls.io/r/Chapabu/codeception-module-drupal?branch=master)
+Branch | Build Status | Coverage
+-------|--------------|----------
+Master|[![Build Status](https://travis-ci.org/Chapabu/codeception-module-drupal.svg?branch=master)](https://travis-ci.org/Chapabu/codeception-module-drupal)|[![Coverage](https://coveralls.io/repos/Chapabu/codeception-module-drupal/badge.svg?branch=master)](https://coveralls.io/r/Chapabu/codeception-module-drupal?branch=master)
+Develop|[![Build Status](https://travis-ci.org/Chapabu/codeception-module-drupal.svg?branch=develop)](https://travis-ci.org/Chapabu/codeception-module-drupal)|[![Coverage](https://coveralls.io/repos/Chapabu/codeception-module-drupal/badge.svg?branch=develop)](https://coveralls.io/r/Chapabu/codeception-module-drupal?branch=develop)
 
-Codeception This module aims to allow tests to use the Drupal API during
+This module aims to allow tests to use the Drupal API during
 testing. This allows for better functional testing of your Drupal sites.
 
+It also makes test driven development with Drupal significantly easier, as you can make assertions on items that you create through the UI.
+
 ## Installation
 
 ```bash
@@ -18,40 +22,60 @@ In your `*.suite.yml` file, add `Drupal` to your enabled modules list.
 
 ### Example configuration
 
-This will run tests under the assumption that your Drupal installation
-is in a `drupal` sub-directory.
+This will run tests under the assumption that your Drupal installation is in a
+`drupal` sub-directory.
 
 ```yaml
-class_name: AcceptanceTester
-modules:
+class_name: AcceptanceTester modules:
     enabled:
         \Codeception\Module\Drupal7\Drupal7:
             root: 'drupal'
+            relative: yes
 ```
 
 ### Options
 
-```root``` - This defines the Drupal root in relation to the
-`codecept.yml` file. If this isn't passed in it defaults to the current
-working directory.
+#### root
+Accepts: `string` Default: `current working directory`
+
+This defines the Drupal root in relation to the `codecept.yml` file. If this isn't passed in it defaults to the current working directory.
+
+#### relative
+Accepts: `yes` or `no` Default: `no`
+
+This allows you to specify if the path to the drupal root is relative from the
+`codeception.yml` file. Accepts `yes` or `no`.
+
+## Contributing
+
+### Coding standards
+
+Please ensure all code follows
+[PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
+standards where possible (with the exception of and Codeception methods that
+don't follow this already, such as `_initialize`)
+
+Tests do not need to follow PSR-2 exactly, but should follow the standards laid out by the current tests (i.e. test method naming doesn't conform to PSR-2, but is more useful in this context).
+
+### Tests
+
+All contributions should come with relevant unit tests as per the rest of the
+suite. For examples, look under the `tests` directory
 
-```relative``` - This allows you to specify if the path to the drupal root is relative from the `codeception.yml` file. Accepts `yes` or `no` (default `no`).
-## Roadmap
+#### Running tests - Linux/OSX
 
-* ~~0.1.0~~
-    * ~~There are assertions for Entities, Bundles, and Fields.~~
-    * ~~There is test coverage of at _least_ 70%~~
+To setup for testing, run `$ composer testinit` followed by `$
+vendor/bin/codecept run` or simply `$ codecept run` if you have Codeception
+installed system wide.
 
-## Running tests
+The `testinit.sh` script assumes you have Drush installed system-wide.  This
+will install Drupal using the username of root and a blank password to a MySQL
+database. Feel free to edit this file should you need to, but please ensure it
+is not committed back.
 
-To setup this module for testing, run `$ composer testinit` followed by
-`$ vendor/bin/codecept run` or simply `$ codecept run` if you have
-Codeception installed system wide.
+#### Running tests - Windows
 
-The `testinit.sh` script assumes you have Drush installed system-wide.  This will install
-Drupal using the username of root and a blank password to a MySQL
-database. Feel free to edit this file should you need to, but please
-ensure it is not committed back.
+If you want to contribute and are running Windows, you should just run the command contained in the `testinit.sh` script using the command line.
 
 ## License
 

composer.json

@@ -50,7 +50,6 @@
         }
     ],
     "scripts": {
-        "testinit": "./testinit.sh",
-        "donetesting": "./donetesting.sh"
+        "testinit": "./testinit.sh"
     }
 }

testinit.sh

@@ -12,7 +12,6 @@ ADMIN_USER="admin"
 ADMIN_PASSWORD="admin"
 ADMIN_MAIL="null@dev.null"
 PATH_TO_DRUPAL="$PWD/vendor/drupal/drupal"
-MYSQL_URL="mysql://root@localhost/drupal_codeception_test"
 
 echo "$(tput setaf 3)Installing Drupal 7 test site"