Skip to content

Commit

Permalink
Fix Docc landing page
Browse files Browse the repository at this point in the history
  • Loading branch information
ianthetechie committed Sep 7, 2024
1 parent 6e5df19 commit 79ab617
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This package helps you easily add geographic autocomplete search to a SwiftUI ap
* Can bias search results to be nearby a specific location
* Automatically localizes place names based on the user's device settings (where available)

![Screenshot](screenshot.png)
![Screenshot](Sources/StadiaMapsAutocompleteSearch/Documentation.docc/screenshot.png)

## Installation

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# ``StadiaMapsAutocompleteSearch``


## Overview

This package helps you easily add geographic autocomplete search to a SwiftUI app.
It supports most use cases out of the box, and is easily extensible to create a tailored design.

* Displays a search box and list which you can embed in other views
* Provides a callback handler with the result details when users tap a result
* Can bias search results to be nearby a specific location
* Automatically localizes place names based on the user's device settings (where available)

![Screenshot](screenshot)

## Quickstart

First, you'll need a Stadia Maps API key.
Create one for free [here](https://client.stadiamaps.com/signup/?utm_source=spm&utm_campaign=sdk_readme&utm_content=swiftui_autocomplete_landing).

Then, add it to your SwiftUI view like this:

```swift
AutocompleteSearch(apiKey: previewApiKey, onResultSelected: { selection in
// TODO: Selection logic
})
```

Refer to the ``AutocompleteSearch`` documentation for more details on customization.
File renamed without changes

0 comments on commit 79ab617

Please sign in to comment.