From fe53a2329551a481d86c8d62e89d0777f6dbd7ae Mon Sep 17 00:00:00 2001 From: Ian Wagner Date: Wed, 5 Jul 2023 17:52:59 +0900 Subject: [PATCH] Improve searchOnEnter docs --- CHANGELOG.md | 2 +- README.md | 7 +++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1c804e8..afa1271 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,4 +6,4 @@ ## v0.5.0 -- Adds arrow key-based navigation! \ No newline at end of file +- Adds arrow key-based navigation! diff --git a/README.md b/README.md index 773eb10..166ec59 100644 --- a/README.md +++ b/README.md @@ -115,10 +115,13 @@ A single point used to influence results (doesn't follow the map viewport). ### `searchOnEnter` -Controls if pressing the Enter key uses the `/search` endpoint instead of the default `/autocomplete` endpoint. +For address-based forward geocoding applications, it often makes sense to use the forward geocoding (`/search`) endpoint +rather than autocomplete search, once you know that the user has completed their input. The full forward geocoding +endpoint is able to interpolate addresses, and may provide better results with complete input than the autocomplete +endpoint. Opting in to this behavior will send a final forward geocoding request if the user presses enter. Note: the `/search` endpoint is not available to all plans, so check if your plan supports `/search` before enabling -this. +this. You can find the full feature comparison on our [pricing page](https://stadiamaps.com/pricing/). ### `maxResults`