Skip to content

Commit cf561f5

Browse files
francescobiancofrancescobianco
committed
docs: fix README
1 parent 8a95a6a commit cf561f5

1 file changed

Lines changed: 96 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 96 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
1-
# OpenAPI PHP SDK
1+
<div align="center">
2+
<a href="https://openapi.com/">
3+
<img alt="Openapi SDK for PHP" src=".github/assets/repo-header-a3.png" >
4+
</a>
25

3-
A minimal and agnostic PHP SDK for OpenAPI, inspired by the Rust implementation. This SDK provides only the core HTTP primitives needed to interact with any OpenAPI service.
6+
<h1>Openapi® client for PHP</h1>
7+
<h4>The perfect starting point to integrate <a href="https://openapi.com/">Openapi®</a> within your PHP project</h4>
8+
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/)
14+
</div>
15+
16+
## Overview
17+
18+
A minimal and agnostic PHP SDK for Openapi, inspired by a clean client implementation. This SDK provides only the core HTTP primitives needed to interact with any Openapi service.
19+
20+
## Pre-requisites
21+
22+
Before using the Openapi Rust Client, you will need an account at [Openapi](https://console.openapi.com/) and an API key to the sandbox and/or production environment
423

524
## Features
625

@@ -10,6 +29,18 @@ A minimal and agnostic PHP SDK for OpenAPI, inspired by the Rust implementation.
1029
- **HTTP Primitives**: GET, POST, PUT, DELETE, PATCH methods
1130
- **Clean Interface**: Similar to the Rust SDK design
1231

32+
## What you can do
33+
34+
With the Openapi Rust Client, you can easily interact with a variety of services in the Openapi Marketplace. For example, you can:
35+
36+
- 📩 **Send SMS messages** with delivery reports and custom sender IDs
37+
- 💸 **Process bills and payments** in real time via API
38+
- 🧾 **Send electronic invoices** securely to the Italian Revenue Agency
39+
- 📄 **Generate PDFs** from HTML content, including JavaScript rendering
40+
- ✉️ **Manage certified emails** and legal communications via Italian Legalmail
41+
42+
For a complete list of all available services, check out the [Openapi Marketplace](https://console.openapi.com/) 🌐
43+
1344
## Installation
1445

1546
```bash
@@ -69,4 +100,66 @@ This SDK follows a minimal approach with only essential components:
69100

70101
- PHP 8.0 or higher
71102
- cURL extension
72-
- JSON extension
103+
- JSON extension
104+
105+
## Examples
106+
107+
You can find complete examples in the `examples/` directory:
108+
109+
- `examples/token_generation.rs` - Token generation example
110+
- `examples/api_calls.rs` - API calls example
111+
112+
Run examples with:
113+
114+
```bash
115+
cargo run --example token_generation
116+
cargo run --example api_calls
117+
```
118+
119+
## Testing
120+
121+
Run tests with:
122+
123+
```bash
124+
cargo test
125+
```
126+
127+
128+
## Contributing
129+
130+
Contributions are always welcome! Whether you want to report bugs, suggest new features, improve documentation, or contribute code, your help is appreciated.
131+
132+
See [docs/contributing.md](docs/contributing.md) for detailed instructions on how to get started. Please make sure to follow this project's [docs/code-of-conduct.md](docs/code-of-conduct.md) to help maintain a welcoming and collaborative environment.
133+
134+
## Authors
135+
136+
Meet the project authors:
137+
138+
- L. Paderi ([@lpaderiAltravia](https://www.github.com/lpaderiAltravia))
139+
- Openapi Team ([@openapi-it](https://github.com/openapi-it))
140+
141+
## Partners
142+
143+
Meet our partners using Openapi or contributing to this SDK:
144+
145+
- [Blank](https://www.blank.app/)
146+
- [Credit Safe](https://www.creditsafe.com/)
147+
- [Deliveroo](https://deliveroo.it/)
148+
- [Gruppo MOL](https://molgroupitaly.it/it/)
149+
- [Jakala](https://www.jakala.com/)
150+
- [Octotelematics](https://www.octotelematics.com/)
151+
- [OTOQI](https://otoqi.com/)
152+
- [PWC](https://www.pwc.com/)
153+
- [QOMODO S.R.L.](https://www.qomodo.me/)
154+
- [SOUNDREEF S.P.A.](https://www.soundreef.com/)
155+
156+
## License
157+
158+
This project is licensed under the [MIT License](LICENSE).
159+
160+
The MIT License is a permissive open-source license that allows you to freely use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, provided that the original copyright notice and this permission notice are included in all copies or substantial portions of the software.
161+
162+
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.
163+
164+
For more details, see the full license text at the [MIT License page](https://choosealicense.com/licenses/mit/).
165+

0 commit comments

Comments
 (0)