Merge pull request #2 from JonPurvis/readme

add basic readme
JonPurvis · May 15, 2023 · 3d1bb70 · 3d1bb70
2 parents 9cd38c7 + d9bca42
commit 3d1bb70
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/README.md 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