Skip to content

Commit ea288cc

Browse files
docs: fix README badges and credits
1 parent cf561f5 commit ea288cc

2 files changed

Lines changed: 23 additions & 10 deletions

File tree

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
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://img.shields.io/github/actions/workflow/status/<username>/<repo>/rust.yml?branch=main)](https://github.com/<username>/<repo>/actions)
10-
[![Crates.io](https://img.shields.io/crates/v/<crate_name>.svg)](https://crates.io/crates/<crate_name>)
11-
[![Docs.rs](https://img.shields.io/docsrs/<crate_name>)](https://docs.rs/<crate_name>)
12-
[![License](https://img.shields.io/github/license/<username>/<repo>)](LICENSE)
13-
[![Rust Version](https://img.shields.io/badge/rust-1.80+-orange.svg)](https://www.rust-lang.org/)
9+
[![Build Status](https://img.shields.io/github/actions/workflow/status/openapi/openapi-php-sdk/ci.yml?branch=main)](https://github.com/openapi/openapi-php-sdk/actions)
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)](LICENSE)
13+
[![Downloads](https://img.shields.io/packagist/dt/openapi/openapi-sdk)](https://packagist.org/packages/openapi/openapi-sdk)
1414
</div>
1515

1616
## Overview
@@ -106,22 +106,28 @@ This SDK follows a minimal approach with only essential components:
106106

107107
You can find complete examples in the `examples/` directory:
108108

109-
- `examples/token_generation.rs` - Token generation example
110-
- `examples/api_calls.rs` - API calls example
109+
- `examples/token_generation.php` - OAuth token generation example
110+
- `examples/api_calls.php` - HTTP API calls example
111+
- `examples/complete_workflow.php` - End-to-end workflow example
111112

112113
Run examples with:
113114

114115
```bash
115-
cargo run --example token_generation
116-
cargo run --example api_calls
116+
composer run example:token
117+
composer run example:api
118+
composer run example:complete
117119
```
118120

119121
## Testing
120122

121123
Run tests with:
122124

123125
```bash
124-
cargo test
126+
# Run all tests
127+
composer run test
128+
129+
# Run unit tests specifically
130+
composer run test:unit
125131
```
126132

127133

composer.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,12 @@
2121
"require-dev": {
2222
"symfony/dotenv": "^5.3",
2323
"phpunit/phpunit": "^9.5"
24+
},
25+
"scripts": {
26+
"test": "phpunit tests/",
27+
"test:unit": "phpunit tests/ --testsuite=unit",
28+
"example:token": "php examples/token_generation.php",
29+
"example:api": "php examples/api_calls.php",
30+
"example:complete": "php examples/complete_workflow.php"
2431
}
2532
}

0 commit comments

Comments
 (0)