README.md

# Apple.WeatherKit

[![CI](https://github.com/elixir-apple/apple_weather_kit/actions/workflows/ci.yml/badge.svg)](https://github.com/elixir-apple/apple_weather_kit/actions/workflows/ci.yml)
[![Hex.pm](https://img.shields.io/hexpm/v/apple_weather_kit.svg)](https://hex.pm/packages/apple_weather_kit)
[![built with Nix](https://img.shields.io/badge/built%20with%20Nix-5277C3?logo=nixos&logoColor=white)](https://builtwithnix.org)

An client for Apple's WeatherKit REST API.

## Notes

This package is still in its early stages, so it may still undergo significant changes, potentially leading to breaking changes.

## Installation

Add `:apple_weather_kit` to the list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:apple_weather_kit, <requirement>}
  ]
end
```

## Usage

For more information, see the [documentation](https://hexdocs.pm/apple_weather_kit/Apple.WeatherKit.html).

## License

Apache License 2.0