-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
11 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,13 @@ | ||
# Ellen writes a geocoder | ||
# 📫 Airmail 📫 | ||
|
||
Airmail might eventually become a hybrid online/offline geocoder. This is a forever project and a pipe dream, you probably shouldn't use it yet and I may never finish it. | ||
Airmail is an extremely lightweight geocoder[^1] written in pure Rust. Built on top of [tantivy](https://github.com/quickwit-oss/tantivy), it offers an incredibly low memory footprint (substantially under 1GB) and lightning-quick indexing (10k+ POIs per second). Airmail currently supports English queries based on place names and addresses in North American address formats. Other languages and address formats may work, but have not been systematically tested. It is capable of parsing category queries, and work is ongoing to lookup categories in the index. Support for viewport biasing and restriction is planned. | ||
|
||
For now, the parser is reasonably good. | ||
[^1] A geocoder is a search engine for places. When you type in "vegan donut shop" into your maps app of choice, a geocoder is what shows you nearby places that fit your query. | ||
|
||
### Stay Tuned | ||
|
||
I have a repetitive stress injury in my wrist right now so work may be slow, but with any luck there will be progress over the next few months. ✨✨ | ||
|
||
### License | ||
|
||
Dual MIT/Apache 2 license, at your option. |