object-spy/README.md

80 lines
3 KiB
Markdown
Raw Normal View History

<h1 align="center">danjones000/object-spy</h1>
<p align="center">
<strong>Debugging library used to spy on objects' private values/methods</strong>
</p>
<!--
TODO: Make sure the following URLs are correct and working for your project.
Then, remove these comments to display the badges, giving users a quick
overview of your package.
<p align="center">
<a href="https://github.com/danjones000/object-spy"><img src="https://img.shields.io/badge/source-danjones000/object--spy-blue.svg?style=flat-square" alt="Source Code"></a>
<a href="https://packagist.org/packages/danjones000/object-spy"><img src="https://img.shields.io/packagist/v/danjones000/object-spy.svg?style=flat-square&label=release" alt="Download Package"></a>
<a href="https://php.net"><img src="https://img.shields.io/packagist/php-v/danjones000/object-spy.svg?style=flat-square&colorB=%238892BF" alt="PHP Programming Language"></a>
<a href="https://github.com/danjones000/object-spy/blob/main/LICENSE"><img src="https://img.shields.io/packagist/l/danjones000/object-spy.svg?style=flat-square&colorB=darkcyan" alt="Read License"></a>
<a href="https://github.com/danjones000/object-spy/actions/workflows/continuous-integration.yml"><img src="https://img.shields.io/github/workflow/status/danjones000/object-spy/build/main?style=flat-square&logo=github" alt="Build Status"></a>
<a href="https://codecov.io/gh/danjones000/object-spy"><img src="https://img.shields.io/codecov/c/gh/danjones000/object-spy?label=codecov&logo=codecov&style=flat-square" alt="Codecov Code Coverage"></a>
<a href="https://shepherd.dev/github/danjones000/object-spy"><img src="https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fshepherd.dev%2Fgithub%2Fdanjones000%2Fobject-spy%2Fcoverage" alt="Psalm Type Coverage"></a>
</p>
-->
## About
<!--
TODO: Use this space to provide more details about your package. Try to be
concise. This is the introduction to your package. Let others know what
your package does and how it can help them build applications.
-->
This project adheres to a [code of conduct](CODE_OF_CONDUCT.md).
By participating in this project and its community, you are expected to
uphold this code.
## Installation
Install this package as a dependency using [Composer](https://getcomposer.org).
``` bash
composer require danjones000/object-spy
```
<!--
## Usage
Provide a brief description or short example of how to use this library.
If you need to provide more detailed examples, use the `docs/` directory
and provide a link here to the documentation.
``` php
use Danjones000\Spy\Example;
$example = new Example();
echo $example->greet('fellow human');
```
-->
## Contributing
Contributions are welcome! To contribute, please familiarize yourself with
[CONTRIBUTING.md](CONTRIBUTING.md).
## Copyright and License
The danjones000/object-spy library is copyright © [Dan Jones](https://danielrayjones.com/)
and licensed for use under the terms of the
MIT License (MIT). Please see [LICENSE](LICENSE) for more information.