updated changelog and readme

Author: Sandro Keil

CHANGELOG.md

@@ -1,6 +1,6 @@
 # BlockchainWalletApi CHANGELOG
 
-## Version 1.0.0 - TBA
+## Version 1.0.0 - (2014-07-01)
 
 * Satoshi view helper which converts satoshi to other unit e.g. bitcoin
 * Validator support via input filter

README.md

@@ -26,7 +26,7 @@ Put the following into your composer.json
 
     {
         "require": {
-            "sandrokeil/blockchain-wallet-api": "dev-master"
+            "sandrokeil/blockchain-wallet-api": "~1.0"
         }
     }
 
@@ -38,7 +38,7 @@ Copy `config/blockchainwalletapi.local.php.dist` to `config/blockchainwalletapi.
 
 Please refer to [blockchain wallet api documentation](https://blockchain.info/en/api/blockchain_wallet_api) for request details.
 
-These request classes matches to api methods
+**These request classes matches to api methods**
 
  * Send => payment
  * SendMany => sendmany
@@ -50,7 +50,47 @@ These request classes matches to api methods
  * AddressUnarchive => unarchive_address
  * AutoConsolidateAddresses => auto_consolidate
 
-Here is an example how to send bitcoins to a bitcoin address:
+## Configuration
+Connection parameters can be defined in the application configuration:
+
+```php
+<?php
+
+return array(
+    'sake_bwa' => array(
+        'connection' => array(
+            'default' => array(
+                'options' => array(
+                    // see \Sake\BlockchainWalletApi\Service\BlockchainWalletOptions for all configurations
+                    'url' => 'https://blockchain.info/de/merchant/', // note on your country
+                    'guid' => 'your My Wallet identifier (found on the login page)',
+                    'main_password' => 'Your Main My wallet password',
+                    'second_password' => 'Your second My Wallet password if double encryption is enabled',
+                ),
+                'client' => 'Service factory name for Http Client, Lazy-loads a Zend\Http\Client instance if none registered'
+            )
+        )
+    )
+);
+```
+
+## Registered service names
+ * `sake_bwa.service.default`: a \Sake\BlockchainWalletApi\Service\BlockchainWallet instance to send requests to the api
+ * `sake_bwa.service.response`: a \Sake\BlockchainWalletApi\Service\ResponsePluginManager Service plugin manager to create responses via api method name
+ * `sake_bwa.service.request`: a \Sake\BlockchainWalletApi\Service\RequestPluginManager Service plugin manager to create requests via api method name
+ * `sake_bwa.service.input_filter`: a \Sake\BlockchainWalletApi\Service\InputFilterPluginManager Service plugin manager to create input filter via api method name
+ * `sake_bwa.service.hydrator`: a \Zend\Stdlib\Hydrator\ClassMethods instance with strategies and filters for requests/responses
+
+## Registered view helper
+To use this view helper you must add `zendframework/zend-view` to your composer dependencies.
+
+ * `satoshi`: a \Zend\View\Helper\AbstractHelper instance which converts satoshi to other unit e.g. bitcoin
+
+## Examples
+This module is very easy to use. However, these code snippets should help you to start.
+
+### Send bitcoins
+Here is an example how to send a transaction to a bitcoin address:
 
 ```php
 <?php
@@ -64,8 +104,8 @@ $request = $sl->get('sake_bwa.service.request')->get('payment');
 // or
 $request = new BlockchainWalletApi\Request\Send();
 
-$request->setAmount(10000000); // in satoshi
-$request->setTo('1A8JiWcwvpY7tAopUkSnGuEYHmzGYfZPiq');
+$request->setAmount(100000); // in satoshi
+$request->setTo('1KwbP2sRHW7uDsxnW8sBbymVwnSsm8cFXC');
 
 try {
     // validate request
@@ -80,6 +120,42 @@ try {
 }
 ```
 
+### Send bitcoins to multiple addresses
+Here is an example how to send a transaction to multiple recipients in the same transaction.
+
+```php
+<?php
+use Sake\BlockchainWalletApi;
+
+// $sl is the service locator
+$blockchain = $sl->get('sake_bwa.service.default');
+
+/* @var $request BlockchainWalletApi\Request\SendMany */
+$request = $sl->get('sake_bwa.service.request')->get('sendmany');
+// or
+$request = new BlockchainWalletApi\Request\SendMany();
+
+$request->setRecipients(
+    array(
+        new BlockchainWalletApi\Request\Recipient('1BzHqGWhdpXyLqiYkAT7sasfCoffYo79tT', 10000),
+        new BlockchainWalletApi\Request\Recipient('1NqH4QkkjDErD9TNC7arDQVMv4zKgfCzmb', 10000),
+    )
+);
+
+try {
+    // validate request
+    if ($blockchain->isValid($request)) {
+        /* @var $response BlockchainWalletApi\Response\SendMany */
+        $response = $service->send($request);
+        // access to response data
+        $transactionHash = $response->getTxHash();
+    }
+} catch (BlockchainWalletApi\Exception\ExceptionInterface $exception) {
+    // error handling
+}
+```
+
+### Get wallet balance
 Here is an example how to retrieve wallet balance:
 
 ```php
@@ -95,7 +171,6 @@ $request = $sl->get('sake_bwa.service.request')->get('balance');
 // or
 $request = new BlockchainWalletApi\Request\WalletBalance();
 
-
 try {
     // validate request
     if ($blockchain->isValid($request)) {
@@ -108,7 +183,9 @@ try {
     // error handling
 }
 ```
-Here is an example how to use satoshi view helper to convert satoshi to other unit:
+
+### Using view helper to convert satoshi to other unit e.g. bitcoins
+Here is an example how to use satoshi view helper to convert satoshi to an other unit:
 
 ```php
 <?php
@@ -121,40 +198,3 @@ echo $this->satoshi($response->getBalanace(), 'mBTC'); // Milli Bits
 // or
 echo $this->satoshi($response->getBalanace(), 'uBTC'); // Micro Bitcoin
 ```
-
-## Configuration
-Connection parameters can be defined in the application configuration:
-
-```php
-<?php
-
-return array(
-    'sake_bwa' => array(
-        'connection' => array(
-            'default' => array(
-                'options' => array(
-                    // see \Sake\BlockchainWalletApi\Service\BlockchainWalletOptions for all configurations
-                    'url' => 'https://blockchain.info/de/merchant/', // note on your country
-                    'guid' => 'your My Wallet identifier (found on the login page)',
-                    'main_password' => 'Your Main My wallet password',
-                    'second_password' => 'Your second My Wallet password if double encryption is enabled',
-                ),
-                'client' => 'Service factory name for Http Client, Lazy-loads a Zend\Http\Client instance if none registered'
-            )
-        )
-    )
-);
-```
-
-## Registered service names
- * `sake_bwa.service.default`: a \Sake\BlockchainWalletApi\Service\BlockchainWallet instance to send requests to the api
- * `sake_bwa.service.response`: a \Sake\BlockchainWalletApi\Service\ResponsePluginManager Service plugin manager to create responses via api method name
- * `sake_bwa.service.request`: a \Sake\BlockchainWalletApi\Service\RequestPluginManager Service plugin manager to create requests via api method name
- * `sake_bwa.service.input_filter`: a \Sake\BlockchainWalletApi\Service\InputFilterPluginManager Service plugin manager to create input filter via api method name
- * `sake_bwa.service.hydrator`: a \Zend\Stdlib\Hydrator\ClassMethods instance with strategies and filters for requests/responses
-
-## Registered view helper
-To use this view helper you must add `zendframework/zend-view` to your composer dependencies.
-
- * `satoshi`: a \Zend\View\Helper\AbstractHelper instance which converts satoshi to other unit e.g. bitcoin
-

src/Request/SendMany.php

@@ -176,7 +176,7 @@ public function setShared($shared)
     /**
      * Returns list of recipients objects
      *
-     * @return array
+     * @return array List of recipient objects
      */
     public function getRecipients()
     {