README.md



# snatch_test_framework #

Copyright (c) 2017 Manuel Rubio

__Authors:__ "Manuel Rubio" ([`manuel@altenwald.com`](mailto:manuel@altenwald.com)).

[![Build Status](https://img.shields.io/travis/snatch-xmpp/snatch_test_framework/master.svg)](https://travis-ci.org/snatch-xmpp/snatch_test_framework)
[![Codecov](https://img.shields.io/codecov/c/github/snatch-xmpp/snatch_test_framework.svg)](https://codecov.io/gh/snatch-xmpp/snatch_test_framework)
[![License: Apache 2.0](https://img.shields.io/github/license/snatch-xmpp/snatch_test_framework.svg)](https://raw.githubusercontent.com/snatch-xmpp/snatch_test_framework/master/LICENSE)
[![Hex](https://img.shields.io/hexpm/v/snatch_test_framework.svg)](https://hex.pm/packages/snatch_test_framework)

Test Framework for the Lightweight XMPP Client Library for Erlang.

Check [the documentation here](doc/testing.md).

Getting Started
---------------

If you are using rebar3 it's easy to put in the test profile the following:

```erlang
{deps, [
    {snatch_test_framework, "0.4.2"}
]}
```

Troubleshooting
---------------

Feel free to create an issue in github to point a bug, flaw or improvement and even send a pull request with a specific change. Read the [LICENSE](http://github.com/snatch-xmpp/snatch_test_framework/blob/master/doc/LICENSE) if you have doubts about what you can do with the code.

Enjoy!


## Modules ##


<table width="100%" border="0" summary="list of modules">
<tr><td><a href="http://github.com/snatch-xmpp/snatch_test_framework/blob/master/doc/snatch_fun_test.md" class="module">snatch_fun_test</a></td></tr></table>