Documentation

README.md

@@ -1,19 +1,11 @@
-# This is my package type-generator
+# Type Generator
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/workflowable/type-generator.svg?style=flat-square)](https://packagist.org/packages/workflowable/type-generator)
 [![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/workflowable/type-generator/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/workflowable/type-generator/actions?query=workflow%3Arun-tests+branch%3Amain)
 [![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/workflowable/type-generator/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/workflowable/type-generator/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/workflowable/type-generator.svg?style=flat-square)](https://packagist.org/packages/workflowable/type-generator)
 
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
-
-## Support us
-
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/type-generator.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/type-generator)
-
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
+Handles the conversion of data structures to TypeScript, with the ability to incorporate other languages.
 
 ## Installation
 
@@ -26,8 +18,7 @@ composer require workflowable/type-generator
 You can publish and run the migrations with:
 
 ```bash
-php artisan vendor:publish --tag="type-generator-migrations"
-php artisan migrate
+php artisan types:generate typescript
 ```
 
 You can publish the config file with:
@@ -36,32 +27,6 @@ You can publish the config file with:
 php artisan vendor:publish --tag="type-generator-config"
 ```
 
-This is the contents of the published config file:
-
-```php
-return [
-];
-```
-
-Optionally, you can publish the views using
-
-```bash
-php artisan vendor:publish --tag="type-generator-views"
-```
-
-## Usage
-
-```php
-$typeGenerator = new Workflowable\TypeGenerator();
-echo $typeGenerator->echoPhrase('Hello, Workflowable!');
-```
-
-## Testing
-
-```bash
-composer test
-```
-
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

src/Commands/TypeGeneratorCommand.php

@@ -17,14 +17,14 @@ class TypeGeneratorCommand extends Command
      *
      * @var string
      */
-    protected $signature = 'types:convert {writer}';
+    protected $signature = 'types:generate {writer}';
 
     /**
      * The console command description.
      *
      * @var string
      */
-    protected $description = 'Command description';
+    protected $description = 'Generate type definitions for discovered classes into a language of your choice.';
 
     /**
      * Execute the console command.