Finalizing documentation

Author: Riimu

CHANGES.md

@@ -1,5 +1,9 @@
 # Changelog #
 
+## v2.0.1 (2015-01-10) ##
+
+  * Improvements on code quality, documentation and tests
+
 ## v2.0.0 (2014-12-29) ##
 
   * Encoding is now separated into external encoding classes

README.md

@@ -27,19 +27,19 @@ at: http://kit.riimu.net/api/phpencoder/
 In order to use this library, the following requirements must be met:
 
   * PHP version 5.4
-
+  
 ## Installation ##
 
 This library can be installed via [Composer](http://getcomposer.org/). To do
-this, download `composer.phar` and require this library as dependency. For
+this, download the `composer.phar` and require this library as a dependency. For
 example:
 
 ```
 $ php -r "readfile('https://getcomposer.org/installer');" | php
 $ php composer.phar require riimu/kit-phpencoder:2.*
 ```
 
-Alternatively, you ca add the dependency to your `composer.json` and run
+Alternatively, you can add the dependency to your `composer.json` and run
 `composer install`. For example:
 
 ```json
@@ -50,9 +50,13 @@ Alternatively, you ca add the dependency to your `composer.json` and run
 }
 ```
 
-If you installed the library via Composer. You can load the library by including
-the `vendor/autoload.php` file. If you do not want to use Composer, you can
-download the latest release and include the `src/autoload.php` file instead.
+Any library that has been installed via Composer can be loaded by including the
+`vendor/autoload.php` file that was generated by Composer.
+
+It is also possible to install this library manually. To do this, download the
+[latest release](https://github.com/Riimu/Kit-PHPEncoder/releases/latest) and
+extract the `src` folder to your project folder. To load the library, include
+the provided `src/autoload.php` file.
 
 ## Usage ##
 

src/Encoder/Encoder.php

@@ -3,7 +3,7 @@
 namespace Riimu\Kit\PHPEncoder\Encoder;
 
 /**
- * Interface for value encoders.
+ * Interface for different types of value encoders.
  * @author Riikka Kalliomäki <[email protected]>
  * @copyright Copyright (c) 2014, Riikka Kalliomäki
  * @license http://opensource.org/licenses/mit-license.php MIT License

src/PHPEncoder.php

@@ -16,7 +16,7 @@
  */
 class PHPEncoder
 {
-    /** @var Encoder\Encoder[] List of used encoders */
+    /** @var Encoder\Encoder[] List of value encoders */
     private $encoders;
 
     /** @var array List of defined encoder option values. */
@@ -33,13 +33,13 @@ class PHPEncoder
     /**
      * Creates a new PHPEncoder instance.
      *
-     * It's possible to define the list of default options for the encoder in
-     * the constructor. You may also customize the list of used encoders by
-     * providing an array of encoders. If null is provided, a list of default of
-     * encoders will be used instead.
+     * Optionally, you can provide a list of default options to the constructor
+     * as an associative array. If you do not want to use the default list of
+     * encoders supplied with the library, you may also provide a list of
+     * value encoders to the constructor.
      *
      * @param array $options List of encoder options
-     * @param null|Encoder\Encoder[] $encoders List of encoders to use
+     * @param null|Encoder[] $encoders List of encoders to use or null for default
      */
     public function __construct(array $options = [], array $encoders = null)
     {
@@ -67,10 +67,10 @@ public function __construct(array $options = [], array $encoders = null)
     /**
      * Adds a new encoder.
      *
-     * Note that values are always encoded by the first encoder that supports
-     * it. Thus, all objects will be caught by the ObjectEncoder, for example.
-     * If you want the encoder to be tried first, set the $prepend parameter
-     * true which adds it to beginning of the list.
+     * Values are always encoded by the first encoder that supports encoding
+     * that type of value. By setting the second optional parameter to true,
+     * you can prepend the encoder to the list to ensure that it will be tested
+     * first.
      *
      * @param Encoder\Encoder $encoder Encoder for encoding values
      * @param boolean $prepend True to prepend the encoder to the list, false to add it as last