Skip to content

Commit

Permalink
docs: update library description
Browse files Browse the repository at this point in the history
Signed-off-by: Evan Sims <[email protected]>
  • Loading branch information
evansims authored Mar 5, 2024
1 parent fa2235c commit cf2af97
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
Lightweight PSR-17 HTTP Factory mocking implementation tailored to simplify testing. This library mocks HTTP requests and is not intended for use in production.

This library inherits [psr-mock/http-message-implementation](https://github.com/psr-mock/http-message-implementation), therefore also making this a provider of PSR-7.
**Lightweight mocking library for [PSR-17 HTTP Factory](https://www.php-fig.org/psr/psr-17/) and [PSR-7 HTTP Message](https://www.php-fig.org/psr/psr-7) implementations, tailor-made to help you create test suites that are easier to write and maintain.**

[![codecov](https://img.shields.io/codecov/c/github/psr-mock/http-factory-implementation)](https://codecov.io/gh/psr-mock/http-factory-implementation) [![packagist](https://img.shields.io/packagist/dt/psr-mock/http-factory-implementation)](https://packagist.org/packages/psr-mock/http-factory-implementation) [![status](https://img.shields.io/github/checks-status/psr-mock/http-factory-implementation/1.x)]() [![license](https://img.shields.io/github/license/psr-mock/http-factory-implementation)]()

This library is primarily intended for use in libraries like SDKs that consume PSR implementations without requiring hard dependencies on specific libraries. The library mocks a real-world implementation and strictly adheres to PSR specifications, enabling you to create test suites that are easier to write and maintain. The library also exposes a robust developer API to help you debug and fix test failures substantially faster.

This package is part of the [PSR Mock](https://github.com/psr-mock) suite of mocking libraries.

## Requirements

- PHP 8.1+
- Composer 2.0+

## Installation

```bash
composer require --dev psr-mock/http-factory-implementation
```

Only install this library as a development dependency (`--dev`).
It's not built for use in production environments.

---

This library is not produced or endorsed by, or otherwise affiliated with, the PHP-FIG.

0 comments on commit cf2af97

Please sign in to comment.