Skip to content

Commit e4c3f05

Browse files
committed
Update README
1 parent 986ef06 commit e4c3f05

File tree

1 file changed

+16
-20
lines changed

1 file changed

+16
-20
lines changed

README.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
1-
# This is my package filament-fields
1+
# Filament Fields
22

33
[![Latest Version on Packagist](https://img.shields.io/packagist/v/vormkracht10/filament-fields.svg?style=flat-square)](https://packagist.org/packages/vormkracht10/filament-fields)
44
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/vormkracht10/filament-fields/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/vormkracht10/filament-fields/actions?query=workflow%3Arun-tests+branch%3Amain)
55
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/vormkracht10/filament-fields/fix-php-code-styling.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/vormkracht10/filament-fields/actions?query=workflow%3A"Fix+PHP+code+styling"+branch%3Amain)
66
[![Total Downloads](https://img.shields.io/packagist/dt/vormkracht10/filament-fields.svg?style=flat-square)](https://packagist.org/packages/vormkracht10/filament-fields)
77

8+
## Nice to meet you, we're [Vormkracht10](https://vormkracht10.nl)
89

10+
Hi! We are a web development agency from Nijmegen in the Netherlands and we use Laravel for everything: advanced websites with a lot of bells and whitles and large web applications.
911

10-
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
12+
## About the package
13+
14+
This package provides a simple way to add configurable fields to your Filament resources. We provide you all Filament Form fields and a way to add your own fields.
1115

1216
## Installation
1317

@@ -17,38 +21,30 @@ You can install the package via composer:
1721
composer require vormkracht10/filament-fields
1822
```
1923

20-
You can publish and run the migrations with:
21-
22-
```bash
23-
php artisan vendor:publish --tag="filament-fields-migrations"
24-
php artisan migrate
25-
```
26-
27-
You can publish the config file with:
24+
You should publish the config file first with:
2825

2926
```bash
3027
php artisan vendor:publish --tag="filament-fields-config"
3128
```
3229

33-
Optionally, you can publish the views using
30+
This will create a `fields.php` file in your `config` directory. Make sure to fill in the tenant relationship and the tenant model. When running the migrations, the fields table will be created with the correct tenant relationship.
31+
32+
You can publish and run the migrations with:
3433

3534
```bash
36-
php artisan vendor:publish --tag="filament-fields-views"
35+
php artisan vendor:publish --tag="filament-fields-migrations"
36+
php artisan migrate
3737
```
3838

39-
This is the contents of the published config file:
39+
## Usage
4040

4141
```php
42-
return [
43-
];
42+
// ...
4443
```
4544

46-
## Usage
45+
### Creating your own fields
4746

48-
```php
49-
$fields = new Vormkracht10\Fields();
50-
echo $fields->echoPhrase('Hello, Vormkracht10!');
51-
```
47+
...
5248

5349
## Testing
5450

0 commit comments

Comments
 (0)