Update README.md (#9)

* Update README.md

* name corrected

* Created EXAMPLES.md

* Updated EXAMPLES.md

* Updated README.md

* Updated README to reflect support for WeatherAPI only

* Update EXAMPLES.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update README.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* 2/3 of the requested changed made

* 3/3 of the requested changes made

* some further changes

---------

Co-authored-by: Kashif Khan <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Author: 3 people

EXAMPLES.md

@@ -0,0 +1,71 @@
+# Examples for Go-API Client
+
+## Example 1: Fetching Current Weather
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/kashifkhan0771/go-weather"
+)
+
+func main() {
+    client := weather.NewClient("YOUR_API_KEY")
+    currentWeather, err := client.GetCurrentWeather("New York")
+    if err != nil {
+        fmt.Println("Error fetching weather:", err)
+        return
+    }
+
+    fmt.Printf("Current temperature in New York: %f°C\n", currentWeather.Temperature)
+}
+
+```
+
+## Example 2: Fetching a 5-Day Forecast
+```go
+Copy code
+package main
+
+import (
+    "fmt"
+    "github.com/kashifkhan0771/go-weather"
+)
+
+func main() {
+    client := weather.NewClient("YOUR_API_KEY")
+    forecast, err := client.GetForecast("Tokyo", 5)
+    if err != nil {
+        fmt.Println("Error fetching forecast:", err)
+        return
+    }
+
+    if forecast.Days == nil {
+        fmt.Println("No forecast data available")
+        return
+    }
+    for _, day := range forecast.Days {
+        fmt.Printf("Date: %s, Temp: %f°C\n", day.Date, day.Temperature)
+    }
+}
+```
+
+## Example 3: Handling Errors
+```go
+Copy code
+package main
+
+import (
+    "fmt"
+    "github.com/kashifkhan0771/go-weather"
+)
+
+func main() {
+    client := weather.NewClient("INVALID_API_KEY")
+    _, err := client.GetCurrentWeather("Paris")
+    if err != nil {
+        fmt.Println("Error:", err)
+    }
+
+}
+```

README.md

@@ -1,33 +1,112 @@
-# Go API Client
+# Go API Weather
 
-### API Docs:
-[WeatherAPI Documentation](https://www.weatherapi.com/docs/)
+[![Go Version](https://img.shields.io/github/go-mod/go-version/kashifkhan0771/go-weather)](https://golang.org/)
+[![License](https://img.shields.io/github/license/kashifkhan0771/go-weather)](LICENSE)
 
-### Usage:
-### Download:
-```bash
-go get "github.com/kashifkhan0771/go-weather"
+Go-Weather is a simple and efficient Go library for fetching weather information from [WeatherAPI](https://www.weatherapi.com). This library allows developers to seamlessly integrate weather data into their applications.
+
+## Features
+- Fetch current weather for any location.
+- Retrieve forecast data for up to 7 days.
+- Supports WeatherAPI integration for reliable weather data.
+- Lightweight
+
+## Installation
+In order to use Go-Weather, you need to have Go installed on your system. The library requires Go version 1.22.0 or higher.
+
+```shell
+go get github.com/kashifkhan0771/go-weather
 ```
-<code>
 
-    package main
+## Usage
+Import the library in your Go application:
 
-    import (
-        "fmt"
-        weatherClient "github.com/kashifkhan0771/go-weather"
-    )
 
-    func main() {
-        config, err := weatherClient.NewWeatherAPIConfig(<Your_API_Key>)
-        if err != nil {
-            panic(err)
-        }
+```go
+package main
 
-        weather, err := config.GetCurrentWeather(weatherClient.Options{Query: "Paris"})
-        if err != nil {
-            panic(err)
-        }
+import (
+    "fmt"
+    "github.com/kashifkhan0771/go-weather"
+)
 
-        fmt.Println(weather)
+func main() {
+    client := weather.NewClient("YOUR_API_KEY")
+    currentWeather, err := client.GetCurrentWeather("London")
+    if err != nil {
+        fmt.Println("Error fetching weather:", err)
+        return
     }
-</code>
+
+    fmt.Printf("Current temperature in London: %f°C\n", currentWeather.Temperature)
+}
+```
+
+## Configuration
+Set up your client with the API key provided by the weather service:
+
+```go
+client := weather.NewClient("YOUR_API_KEY")
+```
+
+### Advanced Congiguration
+Configure the client with additional options (if available):
+
+```go
+client := weather.NewClient(
+    "YOUR_API_KEY",
+    weather.WithTimeout(10*time.Second),
+)
+```
+
+## Supported Functions
+
+### GetCurrentWeather
+
+```go
+func GetCurrentWeather(location string) (*Weather, error)
+```
+
+Fetches current weather for a given location.
+
+Parameters:
+- `location`: City name, postal code, or coordinates
+
+Returns:
+- `*Weather`: Weather information including temperature, conditions, etc.
+- `error`: API errors, network issues, or invalid location
+
+### GetForecast
+
+```go
+func GetForecast(location string, days int) (*Forecast, error)
+```
+
+Retrieves weather forecast for specified days.
+
+Parameters:
+- `location`: City name, postal code, or coordinates
+- `days`: Number of days (1-7)
+
+Returns:
+- `*Forecast`: Forecast information for requested days
+- `error`: API errors, network issues, or invalid parameters
+
+## Examples
+Detailed usage examples for each function are provided in the [EXAMPLES.md](EXAMPLES.md) file.
+
+
+## Contributing
+Contributions are welcome! Please follow the steps below:
+
+- Fork the repository.
+- Create a feature branch: git checkout -b feature-name.
+- Commit your changes: git commit -m 'Add new feature'.
+- Push to your branch: git push origin feature-name.
+- Open a pull request.
+
+## License
+This project is licensed under the MIT License. See the [LICENSE](https://github.com/kashifkhan0771/go-weather/blob/main/LICENSE) file for details.
+
+## Acknowledgments
+Thanks to WeatherAPI for data integration.