Skip to content

Commit

Permalink
Speelcheck and update README
Browse files Browse the repository at this point in the history
  • Loading branch information
cyrillkalita authored and joelbutcher committed Nov 14, 2020
1 parent e9daba7 commit 8750047
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ composer require joelbutcher/laravel-archivable

#### Migrations

The `Archivable` trait works similarly to Laravel's `SoftDeletes` trait. To ensure proper usage of the trait. This package also ships with a helpful macro for Laravel's `\Illuminate\Database\Schema\Blueprint`. To get started, simply add the `archivedAt` macro to your migration, like so:
The `Archivable` trait works similarly to Laravel's `SoftDeletes` trait. This package also ships with a helpful macro for Laravel's `\Illuminate\Database\Schema\Blueprint`. To get started, simply add the `archivedAt` macro to your migration, like so:

```php
Schema::create('posts', function (Blueprint $table) {
Expand All @@ -35,12 +35,13 @@ Schema::create('posts', function (Blueprint $table) {
```

#### Eloquent
You can now, safely, include the `Archivable` tait in your eloquent model:
You can now, safely, include the `Archivable` trait in your Eloquent model:

``` php
namespace App\Models;

use \Illuminate\Database\Eloquent\Model;
use \LaravelArchivable\Archivable;

class Post extends Model {

Expand All @@ -67,6 +68,7 @@ By default, the global scope of this trait uses the `withoutArchived` extension
### Testing

```composer test```

### Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
Expand Down

1 comment on commit 8750047

@usernotnull
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

→ Speelcheck <- and update README :)

Please sign in to comment.