ws/style/uses/docs
[m6w6/seekat] / README.md
1 # seekat
2
3 Fluent Github API access with PHP-7 and [ext-http](https://github.com/m6w6/ext-http).
4 [![Build Status](https://travis-ci.org/m6w6/seekat.svg)](https://travis-ci.org/m6w6/seekat)
5
6 ```php
7 <?php
8
9 use seekat\API;
10
11 (new API)->repos->m6w6->seekat->readme->as("html")->then(function($readme) {
12 echo $readme;
13 }, function($error) {
14 echo $error;
15 });
16
17 $api->send();
18 ```
19
20 > ***Note:*** WIP
21
22
23 ## Installing
24
25 ### Composer
26
27 composer require m6w6/seekat
28
29 ## ChangeLog
30
31 A comprehensive list of changes can be obtained from the
32 [releases overview](./releases).
33
34 ## License
35
36 seekat is licensed under the 2-Clause-BSD license, which can be found in
37 the accompanying [LICENSE](./LICENSE) file.
38
39 ## Contributing
40
41 All forms of contribution are welcome! Please see the bundled
42 [CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
43
44 The list of past and current contributors is maintained in [THANKS](./THANKS).