fix: update README

Add more relevant information

Author: OS-ricardomoreirasilva

README.md

@@ -1,60 +1,25 @@
 # OSGeolocationLib
 
-The `OSGeolocationLib-iOS` is a libary built using `Swift` that enables its callers to access a device's GPS capabilities, such as latitude, longitude and altitude. Its key features are:
-- Get the device's current location.
-- Set up watches for location updates.
-- Clear previously set watches.
-
-## Index
-
-- [Motivation](#motivation)
-- [Usage](#usage)
-- [Features](#features)
-    - [`OSGLOCServicesChecker`](#osglocserviceschecker)
-    	- [Check if Location Services are Enabled](#check-if-location-services-are-enabled)
-    - [`OSGLOCAuthorisationHandler`](#osglocauthorisationhandler)
-    	- [Location Services' Authorisation Status Property](#location-services-authorisation-status-property)
-    	- [Location Services' Authorisation Status Publisher](#location-services-authorisation-status-publisher)
-    	- [Request User's Permission to Use Location Services](#request-users-permission-to-use-location-services)
-    - [`OSGLOCLocationHandler`](#osgloclocationhandler)
-    	- [Current Location Property](#current-location-property)
-    	- [Current Location Publisher](#current-location-publisher)
-    	- [Update the Location Manager's Configuration](#update-the-location-managers-configuration)
-    - [`OSGLOCSingleLocationHandler`](#osglocsinglelocationhandler)
-    	- [Request Device's Current Location](#request-devices-current-location)
-    - [`OSGLOCMonitorLocationHandler`](#osglocmonitorlocationhandler)
-    	- [Start Monitoring the Device's Position](#start-monitoring-the-devices-position)
-    	- [Stop Monitoring the Device's Position](#stop-monitoring-the-devices-position)
-
-## Motivation
-
-This library is to be used by the Geolocation Plugin for OutSystems' [Cordova](https://google.com) and [Capacitor](https://google.com) Plugins.
-
-## Usage
-
-The library is available on CocoaPods as `OSGeolocationLib`. The following is an example of how to insert it into a Cordova plugin (through the `plugin.xml` file).
+A Swift library for iOS that provides simple, reliable access to device GPS capabilities. Get location data, monitor position changes, and manage location services with a clean, modern API.
 
-```xml
-<podspec>
-    <config>
-        <source url="https://cdn.cocoapods.org/"/>
-    </config>
-    <pods use-frameworks="true">
-        ...
-        <pod name="OSGeolocationLib" spec="${version to use}" />
-        ...
-    </pods>
-</podspec>
-```
+[![Version](https://img.shields.io/cocoapods/v/OSGeolocationLib.svg)](https://cocoapods.org/pods/OSGeolocationLib)
+[![Platform](https://img.shields.io/cocoapods/p/OSGeolocationLib.svg)](https://cocoapods.org/pods/OSGeolocationLib)
+[![License](https://img.shields.io/github/license/ionic-team/OSGeolocationLib.svg)](LICENSE)
+
+## Requirements
+
+- iOS 14.0+
+- Swift 5.0+
+- Xcode 15.0+
+
+## Installation
 
-It can also be included as a dependency on other podspecs.
+### CocoaPods
+
+`OSGeolocationLib` is available through [CocoaPods](https://cocoapods.org). Add this to your Podfile:
 
 ```ruby
-Pod::Spec.new do |s|
-  ...
-  s.dependency 'OSGeolocationLib', '${version to use}'
-  ...
-end
+pod 'OSGeolocationLib', '~> 1.0.0'  # Use the latest 1.0.x version
 ```
 
 ## Features
@@ -200,4 +165,88 @@ The method returns immediately. By calling it, it triggers an update to `current
 func stopMonitoringLocation()
 ```
 
-The method should be called whenever you no longer need to received location-related events. 
+The method should be called whenever you no longer need to received location-related events.
+
+## Quick Start
+
+This library is currently used by the Geolocation Plugin for OutSystems' [Cordova](https://google.com) and [Capacitor](https://google.com) Plugins. Please check the library usage there for real use-case scenarios.
+
+## Error Handling
+
+The library uses `OSGLOCLocationError` for error handling regarding location position updates. Possible errors include:
+
+```swift
+enum OSGLOCLocationError: Error {
+    case locationUnavailable
+    case other(_ error: Error)
+}
+```
+
+## Location Data Format
+
+Location updates are delivered as `OSGLOCPositionModel` objects:
+
+```json
+{
+    "latitude": 37.7749,
+    "longitude": -122.4194,
+    "altitude": 0.0,
+    "horizontalAccuracy": 5.0,
+    "verticalAccuracy": 10.0,
+    "course": 180.0,
+    "speed": 0.0,
+    "timestamp": 1641034800000
+}
+```
+
+## Battery Impact Considerations
+
+- High accuracy mode (`enableHighAccuracy: true`) uses GPS and significantly impacts battery life
+- Consider using a larger `minimumUpdateDistanceInMeters` for battery optimization
+- Call `stopMonitoringLocation()` when updates are no longer needed
+
+## Background Location
+
+To enable background location updates:
+
+1. Add required background modes to `Info.plist`:
+```xml
+UIBackgroundModes
+    Location updates
+```
+
+2. Request "always" authorization:
+
+```swift
+locationService.requestAuthorisation(withType: .always)
+```
+
+## Troubleshooting
+
+Common issues and solutions:
+
+1. Location updates not received
+   - Check authorization status
+   - Verify location services are enabled
+   - Ensure proper `Info.plist` permissions
+
+2. Poor accuracy
+   - Enable high accuracy mode
+   - Ensure clear sky view
+   - Wait for better GPS signal
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+`OSGeolocationLib` is available under the MIT license. See the [LICENSE](LICENSE) file for more info.
+
+## Support
+
+- Report issues on our [Issue Tracker](https://github.com/ionic-team/OSGeolocationLib-iOS/issues)