From 307ba74520be7e796ad23abf1c534cd7a6b2980b Mon Sep 17 00:00:00 2001
From: Patrick Heppler <12952240+HepplerDotNet@users.noreply.github.com>
Date: Thu, 14 May 2020 11:44:21 +0200
Subject: [PATCH] Create README.md

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3a6026a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# MySQL FullText Search Trait
+PHP Trait to implement MySQL FullText Search in Eloquent Models
+
+## Installation & Usage
+
+First, pull in the package through Composer.
+
+Run `composer require hepplerdotnet/fulltextsearch`
+
+And then include the Trait within your Eloquent Model to implement FullTextSearch
+.
+
+```php
+
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use HepplerDotNet\FullTextSearch\FullTextSearch;
+
+class FooBar extends Model
+{
+    use FullTextSearch;
+    /* Table Fields which should be searchable */
+    protected $searchable = [
+        'title',
+        'description'
+    ];
+    ...
+ }
+```
+
+Create a fulltext index in MySQL for the fields.
+
+Use it as scope on your Model
+
+```php
+$result = FooBar::search('Foo')->get();
+```
+