Skip to content

Commit

Permalink
feat: Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sweep-ai[bot] committed Mar 12, 2024
1 parent fa5442f commit 6d29e59
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,27 @@
# laravel-dna
Laravel 11 wrapper around php-dna
## Installation

To install the `php-dna` dependency in your Laravel project, run the following command in your terminal:

```
composer require liberu-genealogy/php-dna
```

This will download and install the `php-dna` package, making it available for use within your Laravel application.

## Dispatching the DispatchMatchkitsJob

To dispatch the `DispatchMatchkitsJob` for processing DNA matchkits, you can use the following code snippet:

```php
dispatch(new \App\Jobs\DispatchMatchkitsJob());
```

This will enqueue the job for processing by the Laravel queue system. Make sure your queue worker is running to process the job.

## Usage

After setting up the `php-dna` dependency and dispatching the `DispatchMatchkitsJob`, you can start integrating DNA processing functionalities into your Laravel application. Refer to the `php-dna` documentation for more details on available methods and their usage.

For any custom functionalities or issues, feel free to extend the job or service provider classes as needed.

0 comments on commit 6d29e59

Please sign in to comment.