Skip to content

Commit

Permalink
Updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
olsgreen committed Feb 20, 2021
1 parent 190e868 commit 302094d
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Laravel Scout Database Driver

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
[![Build Status](https://travis-ci.com/boxed-code/laravel-scout-database.svg?branch=master)](https://travis-ci.com/boxed-code/laravel-scout-database)
[![Latest Stable Version](https://poser.pugx.org/boxed-code/laravel-scout-database/v)](//packagist.org/packages/boxed-code/laravel-scout-database) [![Total Downloads](https://poser.pugx.org/boxed-code/laravel-scout-database/downloads)](//packagist.org/packages/boxed-code/laravel-scout-database) [![License](https://poser.pugx.org/boxed-code/laravel-scout-database/license)](//packagist.org/packages/boxed-code/laravel-scout-database)
[![Tests](https://github.com/boxed-code/laravel-scout-database/actions/workflows/run_tests.yml/badge.svg)](https://github.com/boxed-code/laravel-scout-database/actions/workflows/run_tests.yml)

This is a basic database backed driver [for Laravel Scout](https://laravel.com/docs/5.4/scout). It is intended for use during development to avoid the need to setup an elastic instance or agolia and instead uses your active database configuration.

Searchable model attributes are JSON encoded an placed in a text column for simplicity, the very primative 'like' operator is used to perform queries. It is fully functional supporting additional where clauses, etc. The driver deliberately avoides using free text queries & indexes as these are somewhat provider specific and would prevent the goal of it being able to operate with any architecture.

This driver is zero configuration, requiring you to only add the service provider & run the migration.

*Requires Scout 8.x and PHP >=7.2 or >=8.0*

## Installation

You can install the package via composer:
Expand Down

0 comments on commit 302094d

Please sign in to comment.