Update README.md

v1.1.0

Author: olekjs

README.md

@@ -1,7 +1,14 @@
 ## Introduction
 This is a simple package that is used to integrate the Elasticsearch API with a Laravel project.
-The package is based on the Client class, which is not a builder.
-The package is still in development.
+
+_The package is still in development._
+
+- [Installation](#installation)
+- [Custom Indices](#custom-indices)
+- [General usage](#general-usage)
+- [Examples](#examples)
+- [Client class reference](#client-class-reference)
+- [Running Tests](#running-tests)
 
 ## Installation
 
@@ -17,34 +24,81 @@ Set Elasticsearch base URL in `.env` file
 ELASTICSEARCH_URL=http://localhost:9200
 ```
 
+## Custom Indices
+Custom Indices work similarly to Laravel models.
+First, you need to define your own class that extends AbstractIndex:
 
-## Client class reference
+```php
+<?php
+
+namespace App\Indices;
+
+use Olekjs\Elasticsearch\Contracts\AbstractIndex;
+
+class LogIndex extends AbstractIndex
+{
+    protected string $index = 'logs';
+}
+```
+
+You can then use Custom Index to perform a search operation without specifying an index name:
 
 ```php
-    public function search(string $index, array $data): SearchResponseDto;
+use App\Indices\LogIndex;
 
-    public function find(string $index, string|int $id): ?FindResponseDto;
+...
 
-    public function findOrFail(string $index, string|int $id): FindResponseDto;
+LogIndex::query()->where('type', 'error')->get();
+```
 
-    public function create(string $index, string|int $id, array $data): IndexResponseDto;
+### General usage
+There are three options for making requests:
 
-    public function update(string $index, string|int $id, array $data): IndexResponseDto;
+1. Using builder
+```php
+use Olekjs\Elasticsearch\Builder\Builder;
 
-    public function delete(string $index, string|int $id): IndexResponseDto;
+...
 
-    public function searchWhereIn(string $index, string $field, array $values): SearchResponseDto;
+$results = Builder::query()
+    ->index('shops')
+    ->where('slug', 'test-slug')
+    ->where('email', 'test@test.com')
+    ->whereLike('name', 'test')
+    ->whereIn('_id', [123, 321])
+    ->get(); // Resturns SearchResponseDto
+```
+2. Using Custom Index
+How to use Custom Indices? See: Custom Indices
+```php
+use App\Indices\MyCustomIndex;
 
-    public function searchWhereKeyword(string $index, string $field, string $value): SearchResponseDto;
+...
 
-    public function searchWhereLike(string $index, string $field, string|int|float $value): SearchResponseDto;
+$results = MyCustomIndex::query()
+    ->where('slug', 'test-slug')
+    ->where('email', 'test@test.com')
+    ->whereLike('name', 'test')
+    ->whereIn('_id', [123, 321])
+    ->get(); // Resturns SearchResponseDto
+```
 
-    public function increment(string $index, string|int $id, string $field, int $value = 1): IndexResponseDto;
+3. Directly using the Client class
+```php
+use Olekjs\Elasticsearch\Client;
 
-    public function decrement(string $index, string|int $id, string $field, int $value = 1): IndexResponseDto;
+...
+
+$client = new Client();
+$client->search('logs', [
+  'query' => [
+    'bool' => ['filter' => ['term' => ['email' => 'test@test.com']]]
+  ]
+]);
 ```
 
 ### Examples
+
 1. Index the new document
 ```php
 use Olekjs\Elasticsearch\Client;
@@ -80,3 +134,37 @@ $client->findOrFail(
 );
 
 ```
+
+## Client class reference
+
+```php
+    public function search(string $index, array $data): SearchResponseDto;
+
+    public function find(string $index, string|int $id): ?FindResponseDto;
+
+    public function findOrFail(string $index, string|int $id): FindResponseDto;
+
+    public function create(string $index, string|int $id, array $data): IndexResponseDto;
+
+    public function update(string $index, string|int $id, array $data): IndexResponseDto;
+
+    public function delete(string $index, string|int $id): IndexResponseDto;
+
+    public function searchWhereIn(string $index, string $field, array $values): SearchResponseDto;
+
+    public function searchWhereKeyword(string $index, string $field, string $value): SearchResponseDto;
+
+    public function searchWhereLike(string $index, string $field, string|int|float $value): SearchResponseDto;
+
+    public function increment(string $index, string|int $id, string $field, int $value = 1): IndexResponseDto;
+
+    public function decrement(string $index, string|int $id, string $field, int $value = 1): IndexResponseDto;
+```
+
+## Running Tests
+
+To run tests, run the following command
+
+```bash
+  php vendor/bin/testbench package:test
+```