Update readme and base config

Author: likeadeckofcards

README.md

@@ -1,11 +1,11 @@
-# This is my package enum-convertor-laravel
+# Enum Convertor for Laravel
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/likeadeckofcards/enum-convertor-laravel.svg?style=flat-square)](https://packagist.org/packages/likeadeckofcards/enum-convertor-laravel)
 [![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/likeadeckofcards/enum-convertor-laravel/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/likeadeckofcards/enum-convertor-laravel/actions?query=workflow%3Arun-tests+branch%3Amain)
 [![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/likeadeckofcards/enum-convertor-laravel/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/likeadeckofcards/enum-convertor-laravel/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/likeadeckofcards/enum-convertor-laravel.svg?style=flat-square)](https://packagist.org/packages/likeadeckofcards/enum-convertor-laravel)
 
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
+This package adds a command that will take PHP enums and turn them into TS/JS enums for use in frontend development.
 
 ## Support us
 
@@ -23,13 +23,6 @@ You can install the package via composer:
 composer require likeadeckofcards/enum-convertor-laravel
 ```
 
-You can publish and run the migrations with:
-
-```bash
-php artisan vendor:publish --tag="enum-convertor-laravel-migrations"
-php artisan migrate
-```
-
 You can publish the config file with:
 
 ```bash
@@ -40,22 +33,21 @@ This is the contents of the published config file:
 
 ```php
 return [
+    /*
+     * relative paths from the project root
+     */
+    'enum_paths' => [
+        'app/Enums' => 'resources/js/types/enums',
+        // 'input/folder' => 'output/folder'
+    ],
+
+    /*
+     * extension to use for the enum files
+     */
+    'enum_extension' => '.d.ts',
 ];
 ```
 
-Optionally, you can publish the views using
-
-```bash
-php artisan vendor:publish --tag="enum-convertor-laravel-views"
-```
-
-## Usage
-
-```php
-$enumConvertor = new GearboxSolutions\EnumConvertor();
-echo $enumConvertor->echoPhrase('Hello, GearboxSolutions!');
-```
-
 ## Testing
 
 ```bash

config/enum-convertor-laravel.php

@@ -1,10 +1,16 @@
 <?php
 
-// config for GearboxSolutions/EnumConvertor
 return [
+    /*
+     * relative paths from the project root
+     */
     'enum_paths' => [
         'app/Enums' => 'resources/js/types/enums',
+        // 'input/folder' => 'output/folder'
     ],
 
+    /*
+     * extension to use for the enum files
+     */
     'enum_extension' => '.d.ts',
 ];