Skip to content

Commit 8a1aaa8

Browse files
authored
docs: #6 badge and example
1 parent b388537 commit 8a1aaa8

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

README.md

+36-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,36 @@
1-
# coding-sdk-php
2-
CODING SDK for PHP
1+
# CODING SDK for PHP
2+
3+
[![codecov](https://codecov.io/gh/Coding/coding-sdk-php/branch/main/graph/badge.svg?token=aaJqvjWodd)](https://codecov.io/gh/Coding/coding-sdk-php)
4+
[![CI](https://github.com/Coding/coding-sdk-php/actions/workflows/ci.yml/badge.svg)](https://github.com/Coding/coding-sdk-php/actions/workflows/ci.yml)
5+
[![Total Downloads](http://poser.pugx.org/coding/sdk/downloads)](https://packagist.org/packages/coding/sdk)
6+
[![PHP Version Require](http://poser.pugx.org/coding/sdk/require/php)](https://www.php.net/supported-versions.php)
7+
8+
## Install
9+
10+
```shell
11+
composer require coding/sdk
12+
```
13+
14+
## Examples
15+
16+
### Create Iteration
17+
18+
```php
19+
<?php
20+
21+
require 'vendor/autoload.php';
22+
23+
use Coding\Iteration;
24+
25+
$iteration = new Iteration('c127894e5a851cef22dc317f882dfb9ca6054321');
26+
$projectName = 'project-foo';
27+
$result = $iteration->create([
28+
'ProjectName' => $projectName,
29+
'Name' => 'Sprint 1',
30+
]);
31+
echo "https://my-team.coding.net/p/{$projectName}/iterations/${result['Code']}/issues\n";
32+
```
33+
34+
## Resources
35+
36+
- [CODING OPEN API](https://help.coding.net/openapi)

0 commit comments

Comments
 (0)