@wherabouts/react-ui 0.1.0 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Wherabouts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -6,9 +6,9 @@ address form fields. Built on [`@wherabouts/sdk`](https://www.npmjs.com/package/
 styled with Tailwind, and shipped with a prebuilt stylesheet so you can drop them in
 without any build setup.
 
-> **Coverage:** Authoritative Australian addresses (G-NAF). International coverage
-> (US, parts of the EU, and more) is in **beta** and rolling out — availability may
-> vary by deployment.
+> **Coverage:** International — authoritative open address datasets including
+> Australia (G-NAF), the United States, Canada, and parts of Europe. Per-country
+> depth and freshness vary by source.
 
 ## Requirements
 
@@ -73,8 +73,8 @@ keyboard navigation, and customizable rendering.
 <AddressAutocomplete
   client={client}
   onSelect={(address) => setAddress(address)}
-  minCharsToSearch={3}
-  debounceMs={200}
+  minCharsToSearch={4}
+  debounceMs={250}
   maxSuggestions={8}
   enableGeolocation
 />
@@ -86,9 +86,9 @@ keyboard navigation, and customizable rendering.
 | `onSelect` | `(address: AddressWithParsed) => void` | — | Called when a suggestion is chosen. |
 | `onQueryChange` | `(query: string) => void` | — | Called as the input text changes. |
 | `placeholder` | `string` | — | Input placeholder. |
-| `debounceMs` | `number` | `200` | Debounce before querying the API. |
-| `minCharsToSearch` | `number` | `3` | Minimum characters before searching. |
-| `maxSuggestions` | `number` | `10` | Max suggestions to show. |
+| `debounceMs` | `number` | `300` | Debounce before querying the API. |
+| `minCharsToSearch` | `number` | `2` | Minimum characters before searching. |
+| `maxSuggestions` | `number` | `5` | Max suggestions to show. |
 | `enableGeolocation` | `boolean` | `false` | Use the browser's location to bias results (proximity). |
 | `userLat` / `userLng` | `number` | — | Explicit proximity bias instead of geolocation. |
 | `sessionToken` | `string` | — | Group a run of keystrokes into one billable search (see `newSessionToken()` in the SDK). |
@@ -159,6 +159,24 @@ full address.
 - Exported types: `AddressWithParsed`, `AddressI18nStrings`, `AddressValidateFn`,
   `AddressSuggestionInput`, and each component's `*Props`.
 
+## Per-component documentation
+
+Full per-component guides — multiple examples, accessibility notes, and recipes —
+live in [`docs/`](./docs/README.md).
+
+## Interactive docs (Storybook)
+
+This package ships a Storybook with live, interactive examples of every component.
+
+```bash
+pnpm --filter @wherabouts/react-ui storybook
+```
+
+Live stories call the real API. Set `VITE_DEMO_API_KEY` (a publishable,
+origin-scoped key) and optionally `VITE_DEMO_API_BASE_URL` (default
+`https://api.wherabouts.com`) to enable results; without a key, components still
+render with a configuration banner.
+
 ## Styling
 
 The package ships a prebuilt `styles.css` (import it once, as shown above). Components use
@@ -172,5 +190,5 @@ payloads are fully typed.
 
 ## License
 
-UNLICENSED — © Wherabouts. See the repository for usage terms.
+MIT — © Wherabouts.
 </content>