Update README.md

Author: SalemC

README.md

@@ -1,26 +1,62 @@
-# typescriptify-laravel-models
+# TypeScriptify Laravel Models
 
-Effortlessly generate TypeScript interface definitions from Laravel models.
+Effortlessly generate TypeScript interface definitions from Laravel Model classes.
 
-## Example Usage
+## Usage
 
-```php
-<?php
+The main invocation of `php artisan typescriptify:model` with --help lists sub-commands available:
 
-use SalemC\TypeScriptifyLaravelModels\TypeScriptifyModel;
+```
+php artisan typescriptify:model --help
+
+Description:
+  Convert a model to it's TypeScript definition.
+
+Usage:
+  typescriptify:model [options] [--] <model>
+
+Arguments:
+  model                 The fully qualified class name for the model - e.g. App\Models\User
 
-echo TypeScriptifyModel::generate(\App\Models\User::class);
+Options:
+      --includeHidden   Include the protected $hidden properties
 ```
-Will produce:
+
+## Example Usage
+Invocating `php artisan typescriptify:model \App\Models\User` on a fresh Laravel installation 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;
 }
 ```
+
+Or if you prefer, you can instantiate your own version of the `TypeScriptifyModel` class:
+
+```php
+use SalemC\TypeScriptifyLaravelModels\TypeScriptifyModel;
+
+echo (new TypeScriptifyModel(\App\Models\User::class))->generate();
+```
+
+## How It Works
+
+### Database
+
+**TypeScriptifyModels** works primarily by gathering column data from the database your Laravel instance is setup with. Once gathered, it maps column types to known TypeScript types.
+
+### Casts
+
+**TypeScriptifyModels** also respects _predictable_ Laravel casts (specifically `protected $casts` and `protected $dates`) you've setup in the model being converted. It will map all known casts to TypeScript types.
+
+## Caveats
+
+**TypeScriptifyModels** is only able to map _predictable_ data types to TypeScript types. [Custom casts](https://laravel.com/docs/9.x/eloquent-mutators#custom-Casts) and [Custom Accessors](https://laravel.com/docs/9.x/eloquent-mutators#accessors-and-mutators) are not, and cannot be supported.
+
+If **TypeScriptifyModels** fails to map a type to a TypeScript type, it will set the value to `unknown` in the TypeScript interface definition.
+