Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ewilan-riviere committed Jul 25, 2024
1 parent 65bdf78 commit acf06d8
Showing 1 changed file with 6 additions and 14 deletions.
20 changes: 6 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,12 +178,6 @@ Generate `resources/js/types-eloquent.d.ts` file with all models types.
php artisan typescriptable:eloquent
```

With options:

- --`M`|`models-path`: Path to models directory.
- --`O`|`output-path`: Path to output.
- --`P`|`php-path`: Path to output PHP classes, if null will not print PHP classes.

### Spatie Settings

If you use [`spatie/laravel-settings`](https://github.com/spatie/laravel-settings), you can generate `resources/js/types-settings.d.ts` file with all settings types.
Expand All @@ -192,11 +186,6 @@ If you use [`spatie/laravel-settings`](https://github.com/spatie/laravel-setting
php artisan typescriptable:settings
```

With options:

- --`S`|`settings-path`: Path to settings directory.
- --`O`|`output-path`: Path to output.

### Routes

Generate `resources/js/types-routes.d.ts` file with all routes types and `resources/js/routes.ts` for routes references.
Expand All @@ -205,10 +194,13 @@ Generate `resources/js/types-routes.d.ts` file with all routes types and `resour
php artisan typescriptable:routes
```

With options:
### Eloquent listing

Show all Eloquent models with `eloquent:list` command.

- --`R`|`routes-path`: Path to routes directory.
- --`O`|`output-path`: Path to output.
```bash
php artisan eloquent:list
```

## Advanced

Expand Down

0 comments on commit acf06d8

Please sign in to comment.