Skip to content

Commit 7600424

Browse files
committed
readme update
1 parent 08a6881 commit 7600424

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

readme.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,30 @@
1-
[GitHub API](https://developer.github.com/v3/) easy access library. Works with cURL, stream or any of your HTTP client.
1+
[GitHub API](https://developer.github.com/v3/) Easy Access library
2+
==================================================================
3+
4+
Works with cURL, stream or any of your HTTP client.
25

36
[![Downloads this Month](https://img.shields.io/packagist/dm/milo/github-api.svg)](https://packagist.org/packages/milo/github-api)
47
[![Tests](https://github.com/milo/github-api/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/milo/github-api/actions)
58

69

7-
# Installation
10+
Installation
11+
------------
812
Download [release](https://github.com/milo/github-api/releases), decompress and include `github-api.php` manually, or use [Composer](https://getcomposer.org/):
13+
914
```
1015
composer require milo/github-api
1116
```
1217

1318

14-
# Documentation
19+
Documentation
20+
-------------
1521
Everything at [wiki pages](https://github.com/milo/github-api/wiki), including the [short classes description](https://github.com/milo/github-api/wiki/Classes-description).
16-
Whole API documentation is hosted on [Codedoc](https://codedoc.pub/milo/github-api/master/index.html).
1722

1823

1924
Quick Start
20-
===========
21-
List all emojis used on Github.
25+
-----------
26+
List all emojis used on GitHub.
27+
2228
```php
2329
use Milo\Github;
2430

@@ -42,7 +48,8 @@ stdClass Object (
4248
```
4349

4450

45-
# License
51+
License
52+
-------
4653
The MIT License (MIT)
4754

4855
Copyright (c) 2014 Miloslav Hůla

0 commit comments

Comments
 (0)