Merge #822

822: docs: update README with SDK changes and add pagination examples r=Strift a=samuele-ruffino96

# Pull Request

## What does this PR do?
- Updates the README example code to show the necessity to cast the returned value (new `Searchable` interface) to `SearchResult`
- Adds a new comprehensive example demonstrating custom search with pagination
- Shows practical usage of pagination parameters like `setPage()` and `setHitsPerPage()`
- Includes example JSON response showing pagination metadata (totalPages, hitsPerPage, etc.)

## PR checklist
- [x] Changes are clearly described in the PR description above
- [ ] Contributing guidelines have been reviewed (needs confirmer)
- [x] PR title accurately describes changes: "fix(docs): update README example to reflect latest sdk changes"

Co-authored-by: samuele ruffino <[email protected]>
Co-authored-by: Laurent Cazanove <[email protected]>

Author: 3 people

README.md

@@ -147,10 +147,10 @@ import com.meilisearch.sdk.SearchRequest;
 
 // ...
 
-SearchResult results = index.search(
-  new SearchRequest("of")
-  .setShowMatchesPosition(true)
-  .setAttributesToHighlight(new String[]{"title"})
+SearchResult results = (SearchResult) index.search(
+    new SearchRequest("of")
+        .setShowMatchesPosition(true)
+        .setAttributesToHighlight(new String[]{"title"})
 );
 System.out.println(results.getHits());
 ```
@@ -216,6 +216,38 @@ index.search(
   "query": "wonder"
 }
 ```
+#### Custom Search With Pagination <!-- omit in toc -->
+
+```java
+import com.meilisearch.sdk.SearchResultPaginated;
+
+// ...
+
+SearchResultPaginated results = (SearchResultPaginated) index.search(
+    new SearchRequest("wonder")
+        .setPage(1)
+        .setHitsPerPage(20)
+);
+```
+
+```json
+{
+    "hits": [
+        {
+            "id": 2,
+            "title": "Wonder Woman",
+            "genres": ["Action","Adventure"]
+        }
+    ], 
+    "query": "wonder",
+    "processingTimeMs": 0,
+    "hitsPerPage": 20,
+    "page": 1,
+    "totalPages": 1,
+    "totalHits": 1
+}
+```
+
 ## 🛠 Customization
 
 ### JSON <!-- omit in toc -->