Skip to content

Commit 915f530

Browse files
committed
Update Readme.md for Analysis Feature
1 parent 1b48554 commit 915f530

1 file changed

Lines changed: 24 additions & 12 deletions

File tree

README.md

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@
66
<h1>Openapi® client for PHP</h1>
77
<h4>The perfect starting point to integrate <a href="https://openapi.com/">Openapi®</a> within your PHP project</h4>
88

9-
[![Build Status](https://github.com/openapi/openapi-php-sdk/actions/workflows/php.yml/badge.svg)](https://github.com/openapi/openapi-php-sdk/actions/workflows/php.yml)
10-
[![Packagist Version](https://img.shields.io/packagist/v/openapi/openapi-sdk)](https://packagist.org/packages/openapi/openapi-sdk)
11-
[![PHP Version](https://img.shields.io/packagist/php-v/openapi/openapi-sdk)](https://packagist.org/packages/openapi/openapi-sdk)
12-
[![License](https://img.shields.io/github/license/openapi/openapi-php-sdk?v=2)](LICENSE)
13-
[![Downloads](https://img.shields.io/packagist/dt/openapi/openapi-sdk)](https://packagist.org/packages/openapi/openapi-sdk)
14-
<br>
9+
[![Build Status](https://github.com/openapi/openapi-php-sdk/actions/workflows/php.yml/badge.svg)](https://github.com/openapi/openapi-php-sdk/actions/workflows/php.yml)
10+
[![Packagist Version](https://img.shields.io/packagist/v/openapi/openapi-sdk)](https://packagist.org/packages/openapi/openapi-sdk)
11+
[![PHP Version](https://img.shields.io/packagist/php-v/openapi/openapi-sdk)](https://packagist.org/packages/openapi/openapi-sdk)
12+
[![License](https://img.shields.io/github/license/openapi/openapi-php-sdk?v=2)](LICENSE)
13+
[![Downloads](https://img.shields.io/packagist/dt/openapi/openapi-sdk)](https://packagist.org/packages/openapi/openapi-sdk)
14+
<br>
1515
[![Linux Foundation Member](https://img.shields.io/badge/Linux%20Foundation-Silver%20Member-003778?logo=linux-foundation&logoColor=white)](https://www.linuxfoundation.org/about/members)
16+
1617
</div>
1718

1819
## Overview
@@ -27,9 +28,10 @@ Before using the Openapi PHP Client, you will need an account at [Openapi](https
2728

2829
- **Agnostic Design**: No API-specific classes, works with any Openapi service
2930
- **Minimal Dependencies**: Only requires PHP 8.0+ and cURL
30-
- **OAuth Support**: Built-in OAuth client for token management
31+
- **OAuth Support**: Built-in OAuth client for token management
3132
- **HTTP Primitives**: GET, POST, PUT, DELETE, PATCH methods
3233
- **Clean Interface**: Similar to the Rust SDK design
34+
- **Static Analysis**: PHPStan level 6 configuration available via Composer
3335

3436
## What you can do
3537

@@ -81,7 +83,7 @@ $client = new Client($token);
8183
$params = ['denominazione' => 'Stellantis', 'provincia' => 'TO'];
8284
$response = $client->get('https://test.company.openapi.com/IT-advanced', $params);
8385

84-
// POST request
86+
// POST request
8587
$payload = ['limit' => 10, 'query' => ['country_code' => 'IT']];
8688
$response = $client->post('https://test.postontarget.com/fields/country', $payload);
8789

@@ -134,6 +136,17 @@ composer run test
134136
composer run test:unit
135137
```
136138

139+
## Static Analysis
140+
141+
This SDK includes PHPStan as a Composer development dependency to help keep the codebase type-safe and maintainable.
142+
143+
PHPStan is configured in `phpstan.neon` and currently runs at level 6.
144+
145+
Run static analysis with:
146+
147+
```bash
148+
composer run analyse
149+
```
137150

138151
## Contributing
139152

@@ -165,9 +178,9 @@ Meet our partners using Openapi or contributing to this SDK:
165178

166179
## Our Commitments
167180

168-
We believe in open source and we act on that belief. We became Silver Members
169-
of the Linux Foundation because we wanted to formally support the ecosystem
170-
we build on every day. Open standards, open collaboration, and open governance
181+
We believe in open source and we act on that belief. We became Silver Members
182+
of the Linux Foundation because we wanted to formally support the ecosystem
183+
we build on every day. Open standards, open collaboration, and open governance
171184
are part of how we work and how we think about software.
172185

173186
## License
@@ -179,4 +192,3 @@ The MIT License is a permissive open-source license that allows you to freely us
179192
In short, you are free to use this SDK in your personal, academic, or commercial projects, with minimal restrictions. The project is provided "as-is", without any warranty of any kind, either expressed or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.
180193

181194
For more details, see the full license text at the [MIT License page](https://choosealicense.com/licenses/mit/).
182-

0 commit comments

Comments
 (0)