docs: 完善文档

Author: ouqiang

README.md

@@ -1,4 +1,83 @@
 # delayqueue-php
 [延迟队列](https://github.com/ouqiang/delay-queue)PHP客户端
 
-[![Build Status](https://travis-ci.org/ouqiang/delayqueue-php.png)](https://travis-ci.org/ouqiang/delayqueue-php)
+[![Build Status](https://travis-ci.org/ouqiang/delayqueue-php.png)](https://travis-ci.org/ouqiang/delayqueue-php)
+
+依赖
+--------
+* PHP5.4+
+* Composer
+* ext-pcntl
+
+安装
+------------
+```shell
+composer require start-point/delayqueue-php
+```
+
+使用
+------------
+
+```php
+<?php
+
+use DelayQueue\Job;
+use DelayQueue\Util\Time;
+use DelayQueue\DelayQueue;
+
+require 'vendor/autoload.php';
+
+$job = new Job();
+$job->setTopic('order');
+$job->setId('15702398321');
+$job->setDelay(1 * Time::MINUTE);
+$job->setTtr(20 * Time::SECOND);
+$job->setBody([
+   'uid' => 10829378,
+  'created' => 1498657365,
+]);
+
+
+$delayQueue = new DelayQueue('http://127.0.0.1:9277');
+// 处理Job的类名
+$className = 'Demo\\Handler\\OrderHandler';
+try {
+    // 添加一个Job到队列
+    $delayQueue->push($className, $job);
+
+    // 从队列中删除Job
+    $delayQueue->delete('15702398321');
+} catch (Exception $exception) {
+    echo $exception->getMessage();
+}
+````
+
+Job后台处理
+----------
+```shell
+php vendor/bin/delayqueue-php -c /path/to/config.ini
+```
+
+创建Job处理类
+----------
+
+```php
+<?php
+
+namespace Demo\Handler;
+
+use DelayQueue\Handler\AbstractHandler;
+
+class OrderHandler extends AbstractHandler
+{
+    protected function perform()
+    {
+        // 未抛出异常视为成功, Job将会被删除
+        // Job唯一标识
+        // $this->id;
+        
+        // Job自定义内容
+        // $this->body;
+    }
+}
+```

bin/delayqueue-php

@@ -16,8 +16,8 @@ if (php_sapi_name() !== 'cli') {
     exit(1);
 }
 
-if (!extension_loaded('pcntl') || !extension_loaded('posix')) {
-    echo 'extension pcntl, posix not loaded';
+if (!extension_loaded('pcntl')) {
+    echo 'extension pcntl not loaded';
     exit(1);
 }
 

composer.json

@@ -15,7 +15,6 @@
   "require": {
     "php": ">= 5.4",
     "ext-pcntl": "*",
-    "ext-posix": "*",
     "monolog/monolog": "^1.0",
     "guzzlehttp/guzzle": "^5.0",
     "psr/container": "^1.0"

tests/DelayQueueTest.php

@@ -3,10 +3,14 @@
 
 namespace DelayQueue\Tests;
 
+use DelayQueue\Container\Container;
 use DelayQueue\Job;
 use DelayQueue\DelayQueue;
 use DelayQueue\Util\Time;
 use DelayQueue\Handler\AbstractHandler;
+use Monolog\Logger;
+use Monolog\Handler\StreamHandler;
+
 
 class DelayQueueTest extends \PHPUnit_Framework_TestCase
 {
@@ -91,7 +95,21 @@ public function testPop(Job $job)
         $this->assertEquals($className, $data['className']);
         $this->assertEquals($job->body, $data['body']);
         /** @var AbstractHandler $class */
-        $class = new $data['className']();
+        $container = new Container();
+        $container->set('logger', function () {
+            $logger = new Logger('delay-queue');
+            $logger->pushHandler(
+                new StreamHandler(
+                    'php://stdout',
+                    Logger::INFO,
+                    true,
+                    null,
+                    true)
+            );
+
+            return $logger;
+        });
+        $class = new $data['className']($container);
         $class->setId($data['id']);
         $class->setBody($data['body']);
         $class->run();