readme wip!

README.md

@@ -1 +1,23 @@
+![docs/img/screenshot.png](docs/img/screenshot.png)
+
 # Laravel Email Viewer
+
+[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/spatie/laravel-permission/run-tests-L8.yml?branch=main&label=Tests)](https://github.com/axyr/laravel-email-viewer/actions?query=workflow%3ATests+branch%3Amain)
+
+## Introduction
+
+View and inspect all emails sent from you Laravel application.
+
+View emails without using external tools like mailtrap for your development or staging environments, so email won't even have to leave your server.
+
+## Key features
+
+- Log all emails to a storage disk or database table
+- Inspect HTML, attachments and all email headers
+- More to come!
+
+## Installation
+
+```php 
+composer require axyr/laravel-email-viewer
+```