Merge pull request #48 from henriquemoody/readme

Update documentation

.gitignore

@@ -1,3 +1,4 @@
 *.lock
 Makefile
+phpunit.xml
 vendor

CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing to Respect\Config
+
+Contributions to Respect\Config are always welcome. You make our lives easier by
+sending us your contributions through GitHub pull requests.
+
+Pull requests for bug fixes must be based on the current stable branch whereas
+pull requests for new features must be based on `master`.
+
+Due to time constraints, we are not always able to respond as quickly as we
+would like. Please do not take delays personal and feel free to remind us here,
+on IRC or on Gitter if you feel that we forgot to respond.
+
+## Using Respect\Config From a Git Checkout
+
+The following commands can be used to perform the initial checkout of Respect\Config:
+
+```shell
+git clone git://github.com/Respect/Config.git
+cd Config
+```
+
+Retrieve Respect\Config's dependencies using [Composer](http://getcomposer.org/):
+
+```shell
+composer install --dev
+```
+
+## Running Tests
+
+After run `composer install` on the library's root directory you must run PHPUnit.
+
+### Linux
+
+You can test the project using the commands:
+```shell
+$ vendor/bin/phpunit
+```
+
+### Windows
+
+You can test the project using the commands:
+```shell
+> vendor\bin\phpunit
+```
+
+No test should fail.
+
+## Sending your code to us
+
+Please see http://help.github.com/pull-requests/.

README.md

@@ -24,33 +24,7 @@ composer require respect/config
 
 Works on PHP 5.3 and 5.4 only.
 
-## Autoloading
-
-You can set up Respect\Config for autoloading. We recommend using the
-SplClassLoader. Here's a nice sample:
-
-````php
-set_include_path('/my/library' . PATH_SEPARATOR . get_include_path());
-require_once 'SplClassLoader.php';
-$respectLoader = new \SplClassLoader();
-$respectLoader->register();
-````
-
-
-## Running Tests
-
-We didn't created our tests just for us to apreciate. To run them,
-you'll need phpunit 3.5 or greater. Then, just chdir into the `/tests` folder
-we distribute and run them like this:
-
-````bash
-cd /my/RespectConfig/tests
-phpunit .
-````
-
-You can tweak the phpunit.xml under that `/tests` folder to your needs.
-#
-=============
+# Feature Guide
 
 ## Variable Expanding