update reade.me

toplan · Dec 6, 2015 · 6de830a · 6de830a
1 parent 9ef88f3
commit 6de830a
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ lightweight and powerful task load balancing for php
 # Install
 
 ```php
-    composer require 'toplan/task-balancer:~0.1.4'
+    composer require 'toplan/task-balancer:~0.1.5'
 ```
 
 # Usage
@@ -54,6 +54,23 @@ Balancer::task('task1', function($task){
 $result = Balancer::run('task1');
 ```
 
+The `$result` structure:
+```php
+[
+    'success' => true,
+    'time' => [
+        'started_at' => '',
+        'finished_at' => ''
+    ],
+    'logs' => [
+        'driver_1' => [
+            ...
+        ],
+        ...
+    ]
+]
+```
+
 # API
 
 ## 1. Create & Run

diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
   "name": "toplan/task-balancer",
   "description": "lightweight and powerful task load balancing for php (like the nginx load balancing)",
   "license": "MIT",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "keywords": ["task", "balance", "load balancing", "balancer"],
   "authors": [
     {