From a8f48b9d202e41c88bfb03c38bac8d5431d33562 Mon Sep 17 00:00:00 2001 From: Benjamin Crozat Date: Wed, 5 Apr 2023 05:26:22 +0200 Subject: [PATCH] Updated README.md --- README.md | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 35d7201..dbe2394 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,37 @@ [![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/smousss/laravel-novalize/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/smousss/laravel-novalize/actions?query=workflow%3Arun-tests+branch%3Amain) [![Total Downloads](https://img.shields.io/packagist/dt/smousss/laravel-novalize.svg?style=flat-square)](https://packagist.org/packages/smousss/laravel-novalize) -## Documentation +## Installation -Novalize for Laravel documentation is accessible here: https://smousss.com +Install the package via Composer: -## Credits +```bash +composer require smousss/laravel-novalize +``` + +Publish the config file: + +```bash +php artisan vendor:publish --tag=novalize-config +``` + +## Usage + +First, [generate a secret key](https://smousss.com/dashboard) on smousss.com. + +Then, create a Nova resource based on your Post model: + +```php +php artisan smousss:novalize App\\Models\\Post +``` + +Alternatively, create a Nova resource based on multiple models: + +```php +php artisan smousss:novalize App\\Models\\Post App\\Models\\Comment +``` + +## Credit Novalize for Laravel has been developed by [Benjamin Crozat](https://benjamincrozat.com) for [Smousss](https://smousss.com) ([Twitter](https://twitter.com/benjamincrozat)).