Merge pull request #141 from typesense/typesense-server-0.24.0-changes

Typesense Server 0.24.0 changes

Author: jasonbosco

README.md

@@ -88,7 +88,7 @@ const typesenseInstantsearchAdapter = new TypesenseInstantSearchAdapter({
     nodes: [
       {
         host: "localhost",
-        path: '', // Optional. Example: If you have your typesense mounted in localhost:8108/typesense, path should be equal to '/typesense'
+        path: "", // Optional. Example: If you have your typesense mounted in localhost:8108/typesense, path should be equal to '/typesense'
         port: "8108",
         protocol: "http",
       },
@@ -146,7 +146,7 @@ const typesenseInstantsearchAdapter = new TypesenseInstantSearchAdapter({
       {
         host: "localhost",
         port: "8108",
-        path: '', // Optional. Example: If you have your typesense mounted in localhost:8108/typesense, path should be equal to '/typesense'
+        path: "", // Optional. Example: If you have your typesense mounted in localhost:8108/typesense, path should be equal to '/typesense'
         protocol: "http",
       },
     ],
@@ -198,7 +198,7 @@ const typesenseInstantsearchAdapter = new TypesenseInstantSearchAdapter({
     nodes: [
       {
         host: "localhost",
-        path: '', // Optional. Example: If you have your typesense mounted in localhost:8108/typesense, path should be equal to '/typesense'
+        path: "", // Optional. Example: If you have your typesense mounted in localhost:8108/typesense, path should be equal to '/typesense'
         port: "8108",
         protocol: "http",
       },
@@ -239,7 +239,7 @@ const typesenseInstantsearchAdapter = new TypesenseInstantSearchAdapter({
     nodes: [
       {
         host: "localhost",
-        path: '', // Optional. Example: If you have your typesense mounted in localhost:8108/typesense, path should be equal to '/typesense'
+        path: "", // Optional. Example: If you have your typesense mounted in localhost:8108/typesense, path should be equal to '/typesense'
         port: "8108",
         protocol: "http",
       },
@@ -321,7 +321,7 @@ For Federated / Multi-Index Search, you'd need to use the `index` widget. To the
 const typesenseInstantsearchAdapter = new TypesenseInstantSearchAdapter({
   server: {
     apiKey: "abcd", // Be sure to use an API key that only allows search operations
-    nodes: [{ host: "localhost", path:'/', port: "8108", protocol: "http" }],
+    nodes: [{ host: "localhost", path: "/", port: "8108", protocol: "http" }],
   },
   // Search parameters that are common to all collections/indices go here:
   additionalSearchParameters: {
@@ -368,7 +368,8 @@ const typesenseInstantsearchAdapter = new TypesenseInstantSearchAdapter({
 ## Compatibility
 
 | Typesense Server | typesense-instantsearch-adapter | instantsearch.js | react-instantsearch | vue-instantsearch | angular-instantsearch |
-| ---------------- | ------------------------------- | ---------------- | ------------------- | ----------------- | --------------------- |
+|------------------|---------------------------------|------------------|---------------------|-------------------|-----------------------|
+| \>= v0.24        | \>= v2.5.0                      | \>= 4.2.0        | \>= 6.0.0           | \>= 2.2.1         | \>= 3.0.0             |
 | \>= v0.21        | \>= v2.0.0                      | \>= 4.2.0        | \>= 6.0.0           | \>= 2.2.1         | \>= 3.0.0             |
 | \>= v0.19        | \>= v1.0.0                      | \>= 4.2.0        | \>= 6.0.0           | \>= 2.2.1         | \>= 3.0.0             |
 | \>= v0.15        | \>= v0.3.0                      | \>= 4.2.0        | \>= 6.0.0           | \>= 2.2.1         | \>= 3.0.0             |