feat: add findBySlug docs

spatie · May 24, 2023 · d691887 · d691887
1 parent 03bf492
commit d691887
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -409,6 +409,16 @@ class YourEloquentModel extends Model
 }
 ```
 
+### Find models by slug
+
+For convenience, you can use the alias `findBySlug` to retrieve a model. The query will compare against the field passed to `saveSlugsTo` when defining the `SlugOptions`.
+
+```php
+$model = Article::findBySlug('my-article');
+```
+
+`findBySlug` also accepts a second parameter `$columns` just like the default Eloquent `find` method.
+
 
 ## Changelog