diff --git a/README.md b/README.md new file mode 100644 index 0000000..42f8bbd --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +![FakerPHP Stripe ID Provider Banner](assets/banner.png) + +# FakerPHP Stripe ID Provider + +## Introduction +This package allows FakerPHP to generate fake IDs which have the same structure you can expect to be returned from +Stripe. The wonderful [Pest](https://pestphp.com/) is used to run tests contained within this package, which requires +a minimum PHP Version of 8.1. + +## Features +This package can currently generate fake IDs for the following Stripe resources: + +- Accounts +- Balance Transactions +- Charges +- Customers +- Fees +- Invoices +- Invoice Items + +## Usage + +_Coming Soon_ + +## Contributing + +_Coming Soon_ diff --git a/assets/banner.png b/assets/banner.png new file mode 100644 index 0000000..d7ad48a Binary files /dev/null and b/assets/banner.png differ