Merge remote-tracking branch 'origin/master'

README.md

@@ -6,12 +6,11 @@
 ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/tomaytotomato/location4j)
 ![GitHub License](https://img.shields.io/github/license/tomaytotomato/location4j)
 
-location4j is a comprehensive Java library designed for efficient and accurate geographical data lookups, encompassing countries, states, and cities. 🌆
+location4j is a simple Java library designed for efficient and accurate geographical data lookups for countries, states, and cities. 🗺️
 
-Unlike other libraries, it operates without relying on third-party APIs, making it both
-cost-effective and fast. 🏎️
+Unlike other libraries, it operates without relying on third-party APIs, making it both cost-effective and fast. 🏎️
 
-Its built-in dataset provides robust functionality for applications requiring detailed geographical information. 💾
+Its built-in dataset provides quick lookups and no need for external HTTP calls. 📀
 
 ## Quick Example 🏗
 
@@ -68,11 +67,11 @@ Here is an overview of the core functionality that location4j offers
 | Find City by City Id         | ✅         | City     |
 | Find Cities by City name     | ✅         | City     |
 
-🟢 location4j can parse free text strings with or without punctuation or capitalisation
-
-e.g.
+🟢 location4j can parse free text strings with or without punctuation or capitalisation e.g.
 > San Francisco, CA, USA
+> 
 > ca united states san francisco
+> 
 > US, San Francisco, california
 
 🔴 location4j cannot find a location based on a small town, street, latitude/longitude or
@@ -163,26 +162,15 @@ public class LocationSearchServiceExample {
 
 ## Motivation 🌱
 
-Parsing location data efficiently is crucial for many applications, yet it can be complex and time-consuming. Third-party services like Google Location API can be costly, and using large language models can introduce significant latency. location4j offers a practical solution with its own dataset, enabling fast and cost-effective geographical lookups. It ensures your application can handle location data accurately without the overhead of external dependencies.
-Location data is very useful to have and provide when creating datasets for analysis, or APIs for
-web/mobile.
-
-However trying to parse this data in a text format can be very time consuming and frustrating.
-
-One solution is to use a third party location service like Google's Location API, but this can
-become very expensive
-when handling lots of data.
+Parsing location data efficiently is crucial for many applications, yet it can be complex and time-consuming. 
 
-Another option would be to use a Large Language Model like ChatGPT or Llama, however the latency in
-processing data
-can be significant.
+Third-party services like Google Location API can be costly, and using large language models can introduce significant latency. 
 
-Most of the times locations need to be detailed to a city.
+location4j offers a practical solution with its own dataset, enabling fast and cost-effective geographical lookups to a city/town level (which is sufficient in most cases).
 
-Therefore I found a dataset for this information and created this library to provide this
-functionality.
+This allows applications to be built without another external dependency and the overheads that come with it.
 
-I may add other functionality in the future if needed.
+I may add other functionality in the future if needed e.g. geolocation to nearest place, geofencing etc.
 
 ## Credits 🙏