From abffccb7fd98334dceaadfa32a2acbfde8a026f3 Mon Sep 17 00:00:00 2001
From: Salem Cresswell <salem.cresswell@btinternet.com>
Date: Thu, 6 Oct 2022 20:50:33 +0100
Subject: [PATCH] Update README.md

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index 656ece7..5013241 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,26 @@
 # typescriptify-laravel-models
+
+Effortlessly generate TypeScript interface definitions from Laravel models.
+
+## Example Usage
+
+```php
+<?php
+
+use SalemC\TypeScriptifyLaravelModels\TypeScriptInterfaceGenerator;
+
+echo TypeScriptInterfaceGenerator::generate(\App\Models\User::class);
+```
+Will produce:
+```ts
+interface User {
+    id: number;
+    name: string;
+    email: string;
+    email_verified_at: string|null;
+    password: string;
+    remember_token: string|null;
+    created_at: string|null;
+    updated_at: string|null;
+}
+```