From 1f9e3c38969faa41e7967bdcea888662c92b5b6f Mon Sep 17 00:00:00 2001
From: Tom <tjlingham@gmail.com>
Date: Mon, 14 Jul 2014 13:13:47 +1000
Subject: [PATCH] Update README.md

Updating the readme - still a long way to go
---
 README.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 51 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 4a52df7..f991da1 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,60 @@ Laravel 4+ Searchy - Searching Made Easy
 Searchy is an easy-to-use Laravel 4+ package that makes running user searches on data in your models easy and effective.
 It requires no other software installed on your server (so a bit slower) but can be setup and ready to go in minutes.
 
+Installation
+----------------------------------------
+Add the service provider to the `providers` array in Laravel's app/config/app.php file:
+```
+'TomLingham\Searchy\SearchyServiceProvider'
+```
+
+Add the Alias to the `aliases` array in Laravel's app/config/app.php file:
+```
+'Searchy' => 'TomLingham\Searchy\SearchBuilder'
+```
+
+
 Usage
------
+----------------------------------------
+To use Searchy, you can take advantage of magic methods.
+
+If you are searching the name column/field of users in a `users` table you would, for example run:
+```
+$users = Searchy::users('name')->query('John Smith');
+```
+you can also write this as:
+
+```
+$users = Searchy::search('users')->query('John Smith');
+```
+These example both return a Laravel DB Query Builder Object, so you will need to chain `get()` to actually return the results in a usable object:
 
 ```
+$users = Searchy::search('users')->query('John Smith')->get();
+```
+
+
+Configuration
+----------------------------------------
+You can publish the configuration file to override the settings by running `php artisan config:publish tom-lingham/searchy`
+
+You can set the default driver to use for ssearches in the configuration file. Your options (At this stage) are: `fuzzy`, `simple` and `levenshtein`.
+
+You can also override these methods using the following syntax when running a search:
 
 ```
+Searchy::driver('fuzzy')->users('name')->query('Bat Man')->get();
+```
+
+
+Drivers
+----------------------------------------
+Searchy takes advantage of 'Drivers' to handle matching various conditions of the fields you specify.
+
+Drivers are simply a specified group of 'Matchers' which match strings based on different conditions.
+
+Currently there are only three drivers: Simple, Fuzzy and Levenshtein (Experimental).
+
 
 
 ### Road Map
@@ -18,3 +66,5 @@ So, the intention is to (in the future):
 
 1. Remove Searchy's dependancy on Laravel
 2. Include more drivers for more advanced searching (Including file searching, indexing and more)
+3. Implement an AJAX friendly interface for searching models and implementing autosuggestion features on the front end
+4. Speed up search performance