Skip to content

Commit

Permalink
Updated the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
kirkbushell committed Jan 31, 2024
1 parent 7a0954a commit 200e303
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ will ensure you can do exactly that. It transforms all attribute access from cam
providing a unified coding style across your application. This means everything from attribute access to JSON API
responses will all be camelCased. To use, simply add the CamelCased trait to your model:

use \Eloquence\Behaviours\CamelCased;
use \Eloquence\Behaviours\HasCamelCasing;

### Note!

Expand Down Expand Up @@ -169,7 +169,7 @@ Sluggable is another behaviour that allows for the easy addition of model slugs.

```php
class User extends Model {
use Sluggable;
use HasSlugs;

public function slugStrategy(): string
{
Expand All @@ -192,14 +192,18 @@ That's it! Easy huh?

# Upgrading from v10
Version 11 of Eloquence is a complete rebuild and departure from the original codebase, utilising instead PHP 8.1 attributes
and moving away from traits/class extensions where possible. This means that in some projects a lot of udpates will need to
and moving away from traits/class extensions where possible. This means that in some projects many updates will need to
be made to ensure that your use of Eloquence continues to work.

## 1. Class renames

* Camelcasing has been renamed to HasCamelCasing
* Sluggable renamed to HasSlugs

## 2. Updates to how caches work
All your cache implementations will need to be modified following the guide above. But in short, you'll need to import
and apply the provided attributes to the relationship methods on your models that require aggregated cache values.

## Changelog

#### 11.0.0
Expand Down

0 comments on commit 200e303

Please sign in to comment.