readme

Author: lepikhinb

README.md

@@ -5,15 +5,46 @@
 [![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/lepikhinb/laravel-typescript/Check%20&%20fix%20styling?label=code%20style)](https://github.com/lepikhinb/laravel-typescript/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/lepikhinb/laravel-typescript.svg?style=flat-square)](https://packagist.org/packages/lepikhinb/laravel-typescript)
 
----
-xxx
----
+The package lets you generate TypeScript interfaces from your Laravel models.
 
-yyy
-zzz
+## Introduction
+Say you have a model which has several properties (database columns) and multiple relations.
+```php
+class Product extends Model
+{
+    public function category(): BelongsTo
+    {
+        return $this->belongsTo(Category::class);
+    }
+
+    public function features(): HasMany
+    {
+        return $this->hasMany(Feature::class);
+    }
+}
+```
+
+Laravel TypeScript will generate the following namespaced TypeScript interface:
+
+```typescript
+declare namespace App.Models {
+    export interface Product {
+        id: number;
+        category_id: number;
+        name: string;
+        price: number;
+        created_at: string | null;
+        updated_at: string | null;
+        category?: App.Models.Category | null;
+        features?: Array<App.Models.Feature> | null;
+    }
+    ...
+}
+```
 
 ## Installation
 
+**Laravel 8 and PHP 8 are required.**
 You can install the package via composer:
 
 ```bash
@@ -35,17 +66,33 @@ return [
 
     'output' => resource_path('js/models.d.ts'),
 
+    // load namespaces from composer's `dev-autoload`
     'autoloadDev' => false,
 ];
 
 ```
 
 ## Usage
 
+Generate TypeScript interfaces.
 ```bash
 php artisan typescript:generate
 ```
 
+Example usage with Vue 3:
+```typescript
+import { defineComponent, PropType } from "vue";
+
+export default defineComponent({
+    props: {
+        product: {
+            type: Object as PropType<App.Models.Product>,
+            required: true,
+        },
+    },
+}
+```
+
 ## Testing
 
 ```bash