From 70981b884b74a39cc527c8a95645c7974ced3cde Mon Sep 17 00:00:00 2001 From: Jordan Hall Date: Tue, 8 Aug 2017 13:32:59 +0100 Subject: [PATCH] Improve documentation --- README.md | 22 +++------------------- 1 file changed, 3 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index c62a26f..7d585fd 100644 --- a/README.md +++ b/README.md @@ -39,22 +39,6 @@ $results = $search->query('test product', 10); var_dump($results); ``` -The results are returned as an associative array, in the following format. - -```php -Array -( - // [Record Primary Key] => Relevance (higher is more relevant) - - [16647] => 402.17040273556 - [16651] => 402.04274717241 - [17190] => 401.14345056617 - [15348] => 303.11566587702 - [15345] => 303.04049844237 - [15349] => 302.90270308353 - [15347] => 302.81635802469 - [15344] => 302.78347032992 - [15346] => 302.61082737487 - [14532] => 302.27662411888 -) -``` \ No newline at end of file +The results are returned as a `SearchResults` object containing an array of `SearchResult` objects. +This `SearchResults` object also contains various statistics such as the highlest, lowest and average relevances, +and the time taken to perform the search.