# Stickerclient

[![Build and Test](https://github.com/tajacks/elixir-stickerclient/actions/workflows/elixir-build-and-test.yml/badge.svg?branch=main)](https://github.com/tajacks/elixir-stickerclient/actions/workflows/elixir-build-and-test.yml)
[![Coverage Status](https://coveralls.io/repos/github/tajacks/elixir-stickerclient/badge.svg?branch=main)](https://coveralls.io/github/tajacks/elixir-stickerclient?branch=main)

StickerClient is an Elixir library for interfacing with the Signal Stickers API. 

## Installation

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

```elixir
def deps do
  [
    {:stickerclient, "~> 0.1.0"}
  ]
end
```

## Documentation

Documentation for this package can be found on [HexDocs](https://hexdocs.pm/stickerclient/) and it 
is recommended to start by reading the [overview documentation](https://hexdocs.pm/stickerclient/StickerClient.html#content)

## Acknowledgements

Many thanks to the team at [signalstickers](https://github.com/signalstickers/signalstickers-client) for building the 
Python client, from which this project was inspired. 

## Legal

This project is not at all officially affiliated with Signal messenger or any of Signals related entities. 

Signal is a registered trademark in the United States and other countries.

Signal's official legal policies can be viewed [here](https://signal.org/legal/).