Skip to content

Commit 4008066

Browse files
committed
docs: Add README badges and description
1 parent 5ebebea commit 4008066

2 files changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
11
# WP Exceptions
22

3+
<img src="https://raw.githubusercontent.com/Attributes-PHP/wp-exceptions/main/images/wp-exceptions-wallpaper.png" alt="Throw exceptions instead of returning WP_Error">
4+
<p align="center">
5+
<a href="https://github.com/Attributes-PHP/wp-exceptions/actions"><img alt="GitHub Actions Workflow Status (main)" src="https://img.shields.io/github/actions/workflow/status/Attributes-PHP/wp-exceptions/tests.yml"></a>
6+
<a href="https://codecov.io/gh/Attributes-PHP/wp-exceptions" ><img alt="Code Coverage" src="https://codecov.io/gh/Attributes-PHP/wp-exceptions/graph/badge.svg?token=8N7N9NMGLG"/></a>
7+
<a href="https://packagist.org/packages/Attributes-PHP/wp-exceptions"><img alt="Latest Version" src="https://img.shields.io/packagist/v/Attributes-PHP/wp-exceptions"></a>
8+
<a href="https://packagist.org/packages/Attributes-PHP/wp-exceptions"><img alt="Supported WordPress Versions" src="https://img.shields.io/badge/6.x-versions?logo=wordpress&label=versions"></a>
9+
<a href="https://opensource.org/licenses/MIT"><img alt="Software License" src="https://img.shields.io/badge/Licence-MIT-brightgreen"></a>
10+
</p>
11+
12+
------
313
*WP_Error* was a cool WordPress feature in 2007 but today, we should throw exceptions instead.
14+
15+
## Features
16+
17+
- Stops WordPress execution by converting HTTP exceptions into WP_Error's
18+
- Support for handling custom exceptions
19+
- Compatible with other exception handlers (e.g. [Whoops](https://github.com/filp/whoops))
20+
21+
## Requirements
22+
23+
- PHP 8.1+
24+
- WordPress 6.x
25+
26+
We aim to support versions that haven't reached their end-of-life.
27+
28+
## Installation
29+
30+
```bash
31+
composer require attributes-php/wp-exceptions
32+
```
33+
34+
WP FastEndpoints was created by **[André Gil](https://www.linkedin.com/in/andre-gil/)** and is open-sourced software licensed under the **[MIT license](https://opensource.org/licenses/MIT)**.

images/wp-exceptions-wallpaper.png

127 KB
Loading

0 commit comments

Comments
 (0)