You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

82 lines
3.2 KiB

3 years ago
  1. <p align="center">
  2. <img src="https://raw.githubusercontent.com/nunomaduro/collision/stable/docs/logo.png" alt="Collision logo" width="480">
  3. <br>
  4. <img src="https://raw.githubusercontent.com/nunomaduro/collision/stable/docs/example.png" alt="Collision code example" height="300">
  5. </p>
  6. <p align="center">
  7. <a href="https://github.com/nunomaduro/collision/actions"><img src="https://img.shields.io/github/workflow/status/nunomaduro/collision/Tests.svg" alt="Build Status"></img></a>
  8. <a href="https://scrutinizer-ci.com/g/nunomaduro/collision"><img src="https://img.shields.io/scrutinizer/g/nunomaduro/collision.svg" alt="Quality Score"></img></a>
  9. <a href="https://packagist.org/packages/nunomaduro/collision"><img src="https://poser.pugx.org/nunomaduro/collision/d/total.svg" alt="Total Downloads"></a>
  10. <a href="https://packagist.org/packages/nunomaduro/collision"><img src="https://poser.pugx.org/nunomaduro/collision/v/stable.svg" alt="Latest Stable Version"></a>
  11. <a href="https://packagist.org/packages/nunomaduro/collision"><img src="https://poser.pugx.org/nunomaduro/collision/license.svg" alt="License"></a>
  12. </p>
  13. ---
  14. Collision was created by, and is maintained by **[Nuno Maduro](https://github.com/nunomaduro)**, and is a package designed to give you beautiful error reporting when interacting with your app through the command line.
  15. * It's included on **[Laravel](https://laravel.com)**, the most popular free, open-source PHP framework in the world.
  16. * Built on top of the **[Whoops](https://github.com/filp/whoops)** error handler.
  17. * Supports [Laravel](https://github.com/laravel/laravel), [Symfony](https://symfony.com), [PHPUnit](https://github.com/sebastianbergmann/phpunit), and many other frameworks.
  18. ## Installation & Usage
  19. > **Requires [PHP 7.3+](https://php.net/releases/)**
  20. Require Collision using [Composer](https://getcomposer.org):
  21. ```bash
  22. composer require nunomaduro/collision --dev
  23. ```
  24. ## Laravel Version Compatibility
  25. Laravel | Collision
  26. :---------|:----------
  27. 6.x | 3.x
  28. 7.x | 4.x
  29. 8.x | 5.x
  30. As an example, here is how to require Collision on Laravel 6.x:
  31. ```bash
  32. composer require nunomaduro/collision:^3.0 --dev
  33. ```
  34. ## Phpunit adapter
  35. Phpunit must be 9.0 or higher.
  36. Add the Collision `printerClass` to your `phpunit.xml` in the `phpunit` section:
  37. ```xml
  38. <phpunit
  39. printerClass="NunoMaduro\Collision\Adapters\Phpunit\Printer">
  40. ```
  41. ## No adapter
  42. You need to register the handler in your code:
  43. ```php
  44. (new \NunoMaduro\Collision\Provider)->register();
  45. ```
  46. ## Contributing
  47. Thank you for considering to contribute to Collision. All the contribution guidelines are mentioned [here](CONTRIBUTING.md).
  48. You can have a look at the [CHANGELOG](CHANGELOG.md) for constant updates & detailed information about the changes. You can also follow the twitter account for latest announcements or just come say hi!: [@enunomaduro](https://twitter.com/enunomaduro)
  49. ## Support the development
  50. **Do you like this project? Support it by donating**
  51. - PayPal: [Donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=66BYDWAT92N6L)
  52. - Patreon: [Donate](https://www.patreon.com/nunomaduro)
  53. ## License
  54. Collision is an open-sourced software licensed under the [MIT license](LICENSE.md).
  55. Logo by [Caneco](https://twitter.com/caneco).