fix: readme

README.md

@@ -1,65 +1,50 @@
-# Powerful and intuitive package designed to accelerate REST API development within the Laravel ecosystem
+# Laravel Restify
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/ramaid/laravel-restify.svg?style=flat-square)](https://packagist.org/packages/ramaid/laravel-restify)
-[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/ramaid/laravel-restify/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/ramaid/laravel-restify/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/ramaid/laravel-restify/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/ramaid/laravel-restify/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
+[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/ramaID/laravel-restify/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/ramaID/laravel-restify/actions?query=workflow%3Arun-tests+branch%3Amain)
+[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/ramaID/laravel-restify/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/ramaID/laravel-restify/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/ramaid/laravel-restify.svg?style=flat-square)](https://packagist.org/packages/ramaid/laravel-restify)
 
-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/laravel-restify.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-restify)
-
-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).
+Is a powerful and intuitive package designed to accelerate REST API development within the Laravel ecosystem. With efficient and flexible capabilities, Restify presents an integrated and customizable solution for modern API development. Its seamless integration with Laravel ensures a streamlined experience, making it effortlessly scalable for projects of any size. Gain a development advantage with Laravel Restify — an elegant and feature-rich solution to meet your API needs.
 
 ## Installation
 
 You can install the package via composer:
 
 ```bash
-composer require ramaid/laravel-restify
+composer require ramaid/laravel-restify --dev
 ```
 
-You can publish and run the migrations with:
-
-```bash
-php artisan vendor:publish --tag="laravel-restify-migrations"
-php artisan migrate
-```
+## Usage
 
-You can publish the config file with:
+### Setup requirements
 
 ```bash
-php artisan vendor:publish --tag="laravel-restify-config"
+php artisan restify:setup
 ```
 
-This is the contents of the published config file:
+### Generate data object and controller class
 
-```php
-return [
-];
+```bash
+php artisan restify:gen {name}
 ```
 
-Optionally, you can publish the views using
+### Generate typescript type
 
 ```bash
-php artisan vendor:publish --tag="laravel-restify-views"
+php artisan typescript:transform
 ```
 
-## Usage
+## Testing
 
-```php
-$laravelRestify = new RamaID\LaravelRestify();
-echo $laravelRestify->echoPhrase('Hello, RamaID!');
+```bash
+composer test
 ```
 
-## Testing
+### Development
 
 ```bash
-composer test
+composer config repositories.laravel-restify '{"type": "path", "url": "/Users/rama/Personal/meta-forge-phpunit/laravel-restify", "options": {"symlink": true}}'
 ```
 
 ## Changelog