Skip to content

Commit 9ecb0cb

Browse files
authored
Update README.md
1 parent b46ac96 commit 9ecb0cb

1 file changed

Lines changed: 13 additions & 4 deletions

File tree

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
[![PHP Pipeline](https://github.com/zeroSal/php-seven/actions/workflows/actions.yaml/badge.svg?branch=main)](https://github.com/zeroSal/php-seven/actions/workflows/actions.yaml)
22

33
# php-seven
4-
PHP common client adapters library.
4+
PHP `ISO/OSI` layer 7 protocols adapters library.
55

6-
![lighting](https://github.com/user-attachments/assets/e06eeae2-55f9-4abb-9a9b-3dac22c68d8f)
6+
<img width="128" height="128" alt="seven" src="https://github.com/user-attachments/assets/a2655528-ed04-41e7-b4bb-87b490700888" />
77

8-
[Icon by Freepik - Flaticon](https://www.flaticon.com/free-icons/builder)
8+
[Icon by smalllikeart - Flaticon](https://www.flaticon.com/free-icons/seven)
99

1010
## Why this library?
11-
1211
This library speeds up developing of clients via common layer 7 communication protocols, providing `ready-to-use` and `dependency-injection-friendly` adapters.
1312

13+
## Protocols
14+
Below the exaustive list of supported protocols.
15+
- `HTTP(s)` authenticated via `Basic` and `Bearer`
16+
- `SSH` authenticated via `IdentityFile` (asymmetric key pair)
17+
1418
## Installation
1519
```bash
1620
composer require sal/php-seven
@@ -84,3 +88,8 @@ class MyAwesomeClient
8488
}
8589
}
8690
```
91+
92+
# Contribution
93+
Contributions are always welcomed (both issues opening and pull requests).
94+
## Improve the code
95+
Fork the project, perform your improvements and open a pull request. **Note**: pull requests **MUST** include related unit tests and related documentation if needed. All pull requests **MUST** be linked to an issue.

0 commit comments

Comments
 (0)