fix README examples
authorMichael Wallner <mike@php.net>
Thu, 2 Jun 2016 15:49:55 +0000 (17:49 +0200)
committerMichael Wallner <mike@php.net>
Thu, 2 Jun 2016 15:51:10 +0000 (17:51 +0200)
README.md

index 27f04d52bbf1a0d8b4d80a8d52b6d27bcdfede07..9dccecd00eacdd20a1f9616f45f3d055c52dc885 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,14 +1,19 @@
 # seekat
 
-Fluent Github API access with PHP-7 and [ext-http](https://github.com/m6w6/ext-http).
 [![Build Status](https://travis-ci.org/m6w6/seekat.svg)](https://travis-ci.org/m6w6/seekat)
 
+Fluent Github API access with PHP-7 and [ext-http](https://github.com/m6w6/ext-http).
+
+Simple example:
+
 ```php
 <?php
 
 use seekat\API;
 
-(new API)->repos->m6w6->seekat->readme->as("html")->then(function($readme) {
+$api = new API;
+
+$api->repos->m6w6->seekat->readme->as("html")->then(function($readme) {
        echo $readme;
 }, function($error) {
        echo $error;
@@ -17,6 +22,60 @@ use seekat\API;
 $api->send();
 ```
 
+Full example:
+
+```php
+<?php
+
+require_once __DIR__."/../vendor/autoload.php";
+
+use seekat\API;
+
+$cli = new http\Client("curl", "seekat");
+$cli->configure([
+       "max_host_connections" => 10,
+       "max_total_connections" => 50,
+]);
+
+$log = new Monolog\Logger("seekat");
+$log->pushHandler((new Monolog\Handler\StreamHandler(STDERR))->setLevel(Monolog\Logger::WARNING));
+
+$api = new API([
+       "Authorization" => "token ".getenv("GITHUB_TOKEN")
+], null, $cli, $log);
+
+$api(function($api) {
+       $repos = yield $api->users->m6w6->repos([
+               "visibility" => "public",
+               "affiliation" => "owner"
+       ]);
+       while ($repos) {
+               $next = $repos->next();
+
+               $batch = [];
+               foreach ($repos as $repo) {
+                       $batch[] = $repo->hooks();
+               }
+               foreach (yield $batch as $key => $hooks) {
+                       if (!count($hooks)) {
+                               continue;
+                       }
+                       printf("%s:\n", $repos->{$key}->name);
+                       foreach ($hooks as $hook) {
+                               if ($hook->name == "web") {
+                                       printf("\t%s\n", $hook->config->url);
+                               } else {
+                                       printf("\t%s\n", $hook->name);
+                               }
+                       }
+               }
+
+               $repos = yield $next;
+       }
+});
+```
+
+
 > ***Note:*** WIP
 
 
@@ -29,7 +88,7 @@ $api->send();
 ## ChangeLog
 
 A comprehensive list of changes can be obtained from the
-[releases overview](./releases).
+[releases overview](https://github.com/m6w6/seekat/releases).
 
 ## License