Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nivv committed Jul 8, 2022
1 parent 29fc159 commit e4fa39f
Showing 1 changed file with 26 additions and 35 deletions.
61 changes: 26 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@

[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/support-ukraine.svg?t=1" />](https://supportukrainenow.org)
<!-- [<img src="https://github-ads.s3.eu-central-1.amazonaws.com/support-ukraine.svg?t=1" />](https://supportukrainenow.org) -->
# 🇺🇦

# Basic contact message used for public facing contact forms

Expand All @@ -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

[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/fabriq-contact-form.jpg?t=1" width="419px" />](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:
Expand All @@ -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
Expand All @@ -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' => [
'[email protected]'
],

'bcc_recipients' => ['[email protected]'],

'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
Expand All @@ -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)
Expand Down

0 comments on commit e4fa39f

Please sign in to comment.