Skip to content

Commit 9a35ee9

Browse files
authored
Merge pull request #227 from fbourigault/update-readme
Update readme
2 parents 9886de2 + 24baaf0 commit 9a35ee9

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@ A PHP wrapper to be used with [Gitlab's API](https://github.com/gitlabhq/gitlabh
22
==============
33

44
[![Build Status](https://travis-ci.org/m4tthumphrey/php-gitlab-api.svg?branch=master)](https://travis-ci.org/m4tthumphrey/php-gitlab-api)
5+
[![StyleCI](https://styleci.io/repos/6816335/shield?branch=master)](https://styleci.io/repos/6816335)
6+
[![Total Downloads](https://poser.pugx.org/m4tthumphrey/php-gitlab-api/downloads?format=flat-square)](https://packagist.org/packages/m4tthumphrey/php-gitlab-api)
7+
[![Latest Stable Version](https://poser.pugx.org/m4tthumphrey/php-gitlab-api/version?format=flat-square)](https://packagist.org/packages/m4tthumphrey/php-gitlab-api)
8+
[![Latest Unstable Version](https://poser.pugx.org/m4tthumphrey/php-gitlab-api/v/unstable?format=flat-square)](//packagist.org/packages/m4tthumphrey/php-gitlab-api)
59

610
Based on [php-github-api](https://github.com/m4tthumphrey/php-github-api) and code from [KnpLabs](https://github.com/KnpLabs/php-github-api).
711

@@ -21,12 +25,13 @@ You can visit [HTTPlug for library users](http://docs.php-http.org/en/latest/htt
2125
Versioning
2226
----------
2327

24-
From the 6.0 stable release of Gitlab, I shall now be matching the client version with the Gitlab version. For example
25-
when Gitlab 6.1 is released I will release version 6.1.0 of the API client. If I need to make future updates to the client
26-
before the next API version is released, I'll simply use a 3rd build version - `6.1.1`, `6.1.2` etc for example.
28+
Depending on your Gitlab server version, you must choose the right version of this library.
29+
Please refer to the following table to pick the right one.
2730

28-
It is recommended that you keep your composer file in sync with whatever version of Gitlab you are currently running:
29-
if you are using 6.0, you should require `6.0.*`; 6.1 should be `6.1.*`...
31+
|Version|Gitlab API Version|Gitlab Version|
32+
|-------|------------------|--------------|
33+
|9.x | V4 | >= 9.0 |
34+
|8.x | V3 | < 9.5 |
3035

3136
General API Usage
3237
-----------------

0 commit comments

Comments
 (0)