README.md

# Smppex

![Elixir CI](https://github.com/savonarola/smppex/workflows/Elixir%20CI/badge.svg)
[![Documentation](https://img.shields.io/badge/docs-hexpm-blue.svg)](http://hexdocs.pm/smppex)
[![Version](https://img.shields.io/hexpm/v/smppex.svg)](https://hex.pm/packages/smppex)
[![Coverage Status](https://coveralls.io/repos/github/savonarola/smppex/badge.svg?branch=main&1504538909)](https://coveralls.io/github/savonarola/smppex?branch=main)

SMPP 3.4 protocol and framework implementation in [Elixir](http://elixir-lang.org).

See **[Examples](https://hexdocs.pm/smppex/examples.html)** for details.

## Documentation

API documentation is available at **[hexdocs.pm/smppex](http://hexdocs.pm/smppex)**.

## Live Demo

There is a simple online demo MC (SMPP server) at **[smppex.rubybox.dev](http://smppex.rubybox.dev)**.

## Related projects

A list of related projects can be found **[here](https://hexdocs.pm/smppex/projects.html)**.

## Installation

To install and use the package:

1. Add `smppex` to your list of dependencies in `mix.exs`:

   ```elixir
   def deps do
     [{:smppex, "~> 3.0"}]
   end
   ```

2. Ensure `smppex` is started before your application:

   ```elixir
   def application do
     [applications: [:smppex]]
   end
   ```

## License

This software is licensed under [MIT License](LICENSE).

## Project support

* 2017-2023 © [FunBox](https://github.com/funbox/smppex)
* From 2023 © [Ilya Averyanov](https://av.rubybox.dev)