From e4fa39f92eaaa0b660b8b63611e28534f75d429f Mon Sep 17 00:00:00 2001 From: Albin N Date: Fri, 8 Jul 2022 11:28:49 +0200 Subject: [PATCH] update readme --- README.md | 61 ++++++++++++++++++++++++------------------------------- 1 file changed, 26 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index fcc76f5..a480642 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ -[](https://supportukrainenow.org) + +# 🇺🇦 # Basic contact message used for public facing contact forms @@ -10,14 +11,6 @@ This is where your description should go. Limit it to a paragraph or two. Consider adding a small example. -## Support us - -[](https://spatie.be/github-ad-click/fabriq-contact-form) - -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). - ## Installation You can install the package via composer: @@ -26,13 +19,6 @@ You can install the package via composer: composer require ikoncept/fabriq-contact-form ``` -You can publish and run the migrations with: - -```bash -php artisan vendor:publish --tag="fabriq-contact-form-migrations" -php artisan migrate -``` - You can publish the config file with: ```bash @@ -42,8 +28,32 @@ php artisan vendor:publish --tag="fabriq-contact-form-config" This is the contents of the published config file: ```php + return [ + 'recipients' => [ + 'example@example.com' + ], + + 'bcc_recipients' => ['fopper@ss.com'], + + 'include_app_name' => true, + + 'subject' => 'Nytt meddelande från hemsidan', + + 'mail_view' => 'fabriq-contact-form::emails.contact_plain', + + 'mailable' => \Ikoncept\FabriqContactForm\Mail\ContactMessage::class, + + 'form_request_class' => \Ikoncept\FabriqContactForm\Http\Requests\ContactMessageRequest::class, + + 'validation_rules' => [ + 'name' => 'required|max:125', + 'email' => 'required|max:125', + 'phone' => 'max:30', + 'message' => 'required|max:3000' + ] ]; + ``` Optionally, you can publish the views using @@ -52,31 +62,12 @@ Optionally, you can publish the views using php artisan vendor:publish --tag="fabriq-contact-form-views" ``` -## Usage - -```php -$fabriqContactForm = new Ikoncept\FabriqContactForm(); -echo $fabriqContactForm->echoPhrase('Hello, Ikoncept!'); -``` - ## Testing ```bash composer test ``` -## Changelog - -Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. - -## Contributing - -Please see [CONTRIBUTING](https://github.com/ikoncept/.github/blob/main/CONTRIBUTING.md) for details. - -## Security Vulnerabilities - -Please review [our security policy](../../security/policy) on how to report security vulnerabilities. - ## Credits - [Albin N](https://github.com/ikoncept)