Skip to content

Commit 7f753ad

Browse files
Update README.md
1 parent e4228a2 commit 7f753ad

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,27 @@
1-
PHP GitLab API
2-
==============
1+
# GitLab PHP API Client
32

4-
We present a PHP client for [GitLab](https://gitlab.com/)'s [API v4](https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api).
3+
We present a modern [GitLab API v4](https://docs.gitlab.com/ce/api/) client for PHP.
54

6-
[![Build Status](
7-
https://img.shields.io/github/workflow/status/GitLabPHP/Client/Tests?style=flat-square)](https://github.com/GitLabPHP/Client/actions?query=workflow%3ATests)
8-
[![StyleCI](https://github.styleci.io/repos/6816335/shield?branch=9.18)](https://github.styleci.io/repos/6816335?branch=9.18)
9-
[![Latest Stable Version](https://poser.pugx.org/m4tthumphrey/php-gitlab-api/version?format=flat-square)](https://packagist.org/packages/m4tthumphrey/php-gitlab-api)
10-
[![Total Downloads](https://poser.pugx.org/m4tthumphrey/php-gitlab-api/downloads?format=flat-square)](https://packagist.org/packages/m4tthumphrey/php-gitlab-api)
11-
[![License](https://poser.pugx.org/m4tthumphrey/php-gitlab-api/license?format=flat-square)](https://packagist.org/packages/m4tthumphrey/php-gitlab-api)
5+
![Banner](https://user-images.githubusercontent.com/2829600/86969006-fc2e3b00-c164-11ea-80b7-8750160a65c4.png)
6+
7+
<p align="center">
8+
<a href="https://github.com/GitLabPHP/Client/actions?query=workflow%3ATests"><img src="https://img.shields.io/github/workflow/status/GitLabPHP/Client/Tests?label=Tests&style=flat-square" alt="Build Status"></img></a>
9+
<a href="https://github.styleci.io/repos/6816335"><img src="https://github.styleci.io/repos/6816335/shield" alt="StyleCI Status"></img></a>
10+
<a href="https://github.com/GitLabPHP/Client/releases"><img src="https://img.shields.io/github/release/GitLabPHP/Client?style=flat-square" alt="Latest Version"></img></a>
11+
<a href="https://packagist.org/packages/knplabs/github-api"><img src="https://img.shields.io/packagist/dt/knplabs/github-api?style=flat-square" alt="Packagist Downloads"></img></a>
12+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-brightgreen?style=flat-square" alt="Software License"></img></a>
13+
</p>
1214

1315
This is strongly based on [php-github-api](https://github.com/KnpLabs/php-github-api) by [KnpLabs](https://github.com/KnpLabs). With this in mind, we now have **very similar** clients for:
1416

1517
* [Bitbucket](https://bitbucket.org/) - [bitbucket/client](https://packagist.org/packages/bitbucket/client) by [Graham Campbell](https://github.com/GrahamCampbell).
1618
* [GitHub](https://github.com/) - [knplabs/github-api](https://packagist.org/packages/knplabs/github-api) by [KnpLabs](https://github.com/KnpLabs/php-github-api).
1719
* [GitLab](https://gitlab.com/) - [m4tthumphrey/php-gitlab-api](https://packagist.org/packages/m4tthumphrey/php-gitlab-api) which is this package!
1820

19-
Installation
20-
------------
21+
Feel free to check out the [change log](CHANGELOG.md), [releases](https://github.com/GitLabPHP/Client/releases), [security policy](https://github.com/GitLabPHP/Client/security/policy), [license](LICENSE), [code of conduct](.github/CODE_OF_CONDUCT.md), and [contribution guidelines](.github/CONTRIBUTING.md).
22+
23+
24+
## Installation
2125

2226
This version supports [PHP](https://php.net) 5.6-7.4. To get started, simply require the project using [Composer](https://getcomposer.org). You will also need to install any package that "provides" [`php-http/client-implementation`](https://packagist.org/providers/php-http/client-implementation).
2327

@@ -41,8 +45,7 @@ $ composer require zeichen32/gitlabapibundle:^2.6 php-http/guzzle6-adapter:^2.0.
4145

4246
We are decoupled from any HTTP messaging client with help by [HTTPlug](http://httplug.io). You can visit [HTTPlug for library users](https://docs.php-http.org/en/latest/httplug/users.html) to get more information about installing HTTPlug related packages. [graham-campbell/gitlab](https://github.com/GrahamCampbell/Laravel-GitLab) is by [Graham Campbell](https://github.com/GrahamCampbell) and [zeichen32/gitlabapibundle](https://github.com/Zeichen32/GitLabApiBundle) is by [Jens Averkamp](https://github.com/Zeichen32).
4347

44-
General API Usage
45-
-----------------
48+
## General API Usage
4649

4750
```php
4851
// Token authentication
@@ -62,8 +65,7 @@ $project = $client->projects()->create('My Project', [
6265

6366
```
6467

65-
Example with Pager
66-
------------------
68+
## Example with Pager
6769

6870
to fetch all your closed issue with pagination ( on the gitlab api )
6971

@@ -77,8 +79,7 @@ $issues = $pager->fetchAll($client->issues(), 'all', [null, ['state' => 'closed'
7779

7880
```
7981

80-
Model Usage
81-
-----------
82+
## Model Usage
8283

8384
You can also use the library in an object oriented manner:
8485

@@ -106,8 +107,7 @@ $issue = $project->createIssue('This does not work.', [
106107
$issue->close();
107108
```
108109

109-
The HTTP Client Builder
110-
-----------------------
110+
## HTTP Client Builder
111111

112112
By providing a `Gitlab\HttpClient\Builder` to the `Gitlab\Client` constructor, you can customize the HTTP client. For example, to customize the user agent:
113113

@@ -124,8 +124,8 @@ $client = new Gitlab\Client($builder);
124124

125125
One can read more about HTTPlug plugins [here](https://docs.php-http.org/en/latest/plugins/introduction.html#how-it-works). Take a look around ([API methods](https://github.com/GitLabPHP/Client/tree/9.18/lib/Gitlab/Api), [models](https://github.com/GitLabPHP/Client/tree/9.18/lib/Gitlab/Model)) and please feel free to report any bugs, noting our [code of conduct](.github/CODE_OF_CONDUCT.md).
126126

127-
Contributing
128-
------------
127+
128+
## Contributing
129129

130130
Not all endpoints of the API are implemented yet. We will gladly review and accept pull requests, in accordance with our [contribution guidelines](.github/CONTRIBUTING.md)!
131131

@@ -134,12 +134,12 @@ $ make install
134134
$ make test
135135
```
136136

137-
Security
138-
--------
137+
138+
## Security
139139

140140
If you discover a security vulnerability within this package, please send an email to Graham Campbell at [email protected] or Miguel Piedrafita at [email protected]. All security vulnerabilities will be promptly addressed. You may view our full security policy [here](https://github.com/GitLabPHP/Client/security/policy).
141141

142-
License
143-
-------
144142

145-
PHP GitLab API is licensed under [The MIT License (MIT)](LICENSE).
143+
## License
144+
145+
GitLab PHP API Client is licensed under [The MIT License (MIT)](LICENSE).

0 commit comments

Comments
 (0)