README.md

# This library is no longer being developed. Please use <https://github.com/xp4u1/untis>

<div align="center">
  <h1>Webuntis</h1>
</div>
<div align="center">
    <strong>📚 Elixir wrapper for the (private) Webuntis api 📐</strong>
</div>

<br/>

<div align="center">
    <a href="#">
        <img alt="version" style="height: 33px" src="https://img.shields.io/static/v1.svg?label=Version&message=2.1.1&color=389ad5&labelColor=31c4f3&style=for-the-badge" />
    </a>
    <a href="https://elixir-lang.org">
        <img alt="elixir" style="height: 33px" src="https://img.shields.io/static/v1.svg?label=Made with&message=Elixir&color=ae68cc&labelColor=6e4a7e&style=for-the-badge" />
    </a>
</div>
<div align="center">
    <a href="https://gitlab.com/xp4u1/webuntis/commits/master">
        <img alt="pipeline status" src="https://img.shields.io/gitlab/pipeline/xp4u1/webuntis.svg?style=for-the-badge&logo=gitlab" />
    </a>
    <a href="https://discord.gg/WJtvSkb">
        <img alt="discord status" src="https://img.shields.io/discord/306792205966901250.svg?style=for-the-badge&logo=discord&logoColor=fff&labelColor=8fc965&color=419b5a" />
    </a>
    <a href="#">
        <img alt="open source" src="https://img.shields.io/static/v1.svg?label=Open&message=Source&color=46a4b8&labelColor=3ac1d0&style=for-the-badge" />
    </a>
</div>

<div align="center">
    <h3>
        <a href="https://hexdocs.pm/webuntis">Documentation</a>
        <span> | </span>
        <a href="https://gitlab.com/xp4u1/webuntis/blob/master/CONTRIBUTING.md">Contributing</a>
    </h3>
</div>

<div align="center">
  <sub>Built with ❤︎ by
  <a href="https://gitlab.com/xp4u1">Paul Hoerenz</a> and
  <a href="https://gitlab.com/xp4u1/webuntis/graphs/master">
    contributors
  </a>
  </sub>
</div>

<br />

## Installation

The package can be installed
by adding `webuntis` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:webuntis, "~> 2.1.1"}
  ]
end
```

The documentation can be found at [https://hexdocs.pm/webuntis](https://hexdocs.pm/webuntis).

# Future plans

Webuntis is going to be maintained and added to for the foreseeable future. A small community has developed to try and improve it, and if you have an interest in helping contribute, you're always welcome.

Currently, this is being run by one person, Paul Hoerenz