Add SPI badge; improve docs for default SearchResult view

stadiamaps · Sep 7, 2024 · 6e5df19 · 6e5df19
1 parent 13274ec
commit 6e5df19
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # Stadia Maps Autocomplete Search for SwiftUI
 
+[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fstadiamaps%2Fswiftui-autocomplete-search%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/stadiamaps/swiftui-autocomplete-search) [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fstadiamaps%2Fswiftui-autocomplete-search%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/stadiamaps/swiftui-autocomplete-search)
+
 This package helps you easily add geographic autocomplete search to a SwiftUI app. 
 
 * Displays a search box and list which you can embed in other views

diff --git a/Sources/StadiaMapsAutocompleteSearch/SearchResult.swift b/Sources/StadiaMapsAutocompleteSearch/SearchResult.swift
@@ -3,6 +3,9 @@ import MapKit
 import StadiaMaps
 import SwiftUI
 
+/// A search result view featuring a category image from SFSymbols,
+/// the name of the feature, and (where available) some location context
+/// such as the city, region, or country containing the result.
 public struct SearchResult: View {
     let feature: PeliasGeoJSONFeature
     let relativeTo: CLLocation?