Skip to content

Commit

Permalink
📝 Improving docs
Browse files Browse the repository at this point in the history
  • Loading branch information
contactinquid committed Oct 21, 2023
1 parent 7dce88b commit e90364e
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,29 @@ composer require inquid/laravel-stock

By running `php artisan vendor:publish --provider="Inquid\Stock\StockServiceProvider"` in your project all files for this package will be published. Run `php artisan migrate` to migrate the table. There will now be a `stock_mutations` table in your database.

The configuration file looks this:
```php
<?php

return [

/*
|--------------------------------------------------------------------------
| Default table name
|--------------------------------------------------------------------------
|
| Table name to use to store mutations.
|
*/

'table' => 'stock_mutations',

'stock_mutation_model' => Inquid\Stock\StockMutation::class,

//'special_date_class' => \MongoDB\BSON\UTCDateTime::class,
];
```

## Usage

Adding the `HasStock` trait will enable stock functionality on the Model.
Expand Down

0 comments on commit e90364e

Please sign in to comment.