Skip to content

Commit 06823b8

Browse files
authored
Update README.md
1 parent c63ad17 commit 06823b8

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,14 @@
22

33
---
44

5-
<!--
6-
7-
[![Latest Version on Packagist](https://img.shields.io/packagist/v/typesense/laravel-typesense.svg?style=for-the-badge)](https://packagist.org/packages/typesense/laravel-typesense)
8-
9-
[![PHP from Packagist](https://img.shields.io/packagist/php-v/typesense/laravel-typesense?style=flat-square)](https://packagist.org/packages/typesense/laravel-typesense) [![Total Downloads](https://img.shields.io/packagist/dt/typesense/laravel-typesense.svg?style=flat-square)](https://packagist.org/packages/typesense/laravel-typesense)
10-
11-
-->
12-
13-
# Laravel Scout Typesense Engine
145
<p align="center">
15-
<img src="https://banners.beyondco.de/typesense%2Flaravel-typesense.png?theme=dark&packageManager=composer+require&packageName=typesense%2Flaravel-typesense&pattern=architect&style=style_1&description=Easy+Typesense+support+for+Laravel+Scout&md=1&showWatermark=0&fontSize=100px&images=https%3A%2F%2Flaravel.com%2Fimg%2Flogomark.min.svg">
6+
<img src="https://banners.beyondco.de/Laravel%20Scout%20Driver%20For%20Typesense.png?theme=dark&packageManager=composer+require&packageName=typesense%2Flaravel-scout-typesense-driver&pattern=architect&style=style_1&description=Easy+Typesense+support+for+Laravel+Scout&md=1&showWatermark=0&fontSize=75px&images=https%3A%2F%2Flaravel.com%2Fimg%2Flogomark.min.svg">
167
</p>
178

189
This package makes it easy to add full text search support to your models with Laravel 7.\* to 8.\*.
1910

11+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/typesense/laravel-scout-typesense-driver.svg?style=flat-square)](https://packagist.org/packages/typesense/laravel-scout-typesense-driver) [![PHP from Packagist](https://img.shields.io/packagist/php-v/typesense/laravel-scout-typesense-driver?style=flat-square)](https://packagist.org/packages/typesense/laravel-scout-typesense-driver)
12+
2013
## Contents
2114

2215
- [Installation](#installation)
@@ -31,7 +24,7 @@ This package makes it easy to add full text search support to your models with L
3124
You can install the package via composer:
3225

3326
``` bash
34-
composer require typesense/laravel-typesense
27+
composer require typesense/laravel-scout-typesense-driver
3528
```
3629

3730
Add the service provider:
@@ -168,15 +161,17 @@ $posts->searchable();
168161
```
169162

170163
## Migrating from devloopsnet/laravel-typesense
171-
- Replace `devloopsnet/laravel-typesense` in your composer.json requirements with `typesense/laravel-typesense`
164+
- Replace `devloopsnet/laravel-typesense` in your composer.json requirements with `typesense/laravel-scout-typesense-driver`
172165
- The Scout driver is now called `typesense`, instead of `typesensesearch`. This should be reflected by setting the SCOUT_DRIVER env var to `typesense`,
173166
and changing the config/scout.php config key from `typesensesearch` to `typesense`
174167
- Instead of importing `Devloops\LaravelTypesense\*`, you should import `Typesense\LaravelTypesense\*`
175168
- Instead of models implementing `Devloops\LaravelTypesense\Interfaces\TypesenseSearch`, they should implement `Typesense\LaravelTypesense\Interfaces\TypesenseDocument`
176169
- In the rare case where the `TypesenseEngine` method `delete` is called directly, all the model instances passed to the method must now belong to the same Typesense index
177170

178171
## Authors
179-
This package was based off of https://github.com/AbdullahFaqeir and his company DevLoops' work, https://github.com/devloopsnet/laravel-scout-typesense-engine. Other contributors include:
172+
This package was originally authored by [Abdullah Al-Faqeir](https://github.com/AbdullahFaqeir) and his company DevLoops: https://github.com/devloopsnet/laravel-scout-typesense-engine. It has since been adopted into the Typesense Github org.
173+
174+
Other key contributors include:
180175

181176
- [hi019](https://github.com/hi019)
182177

0 commit comments

Comments
 (0)