[![Build Status](https://travis-ci.org/jcomellas/bstr.svg?branch=master)](https://travis-ci.org/jcomellas/bstr)


bstr
====

Erlang library to use binaries as strings.


Requirements
------------
Tested on the following OTP releases:

- 17.1
- 17.0
- R16B03-1
- R16B03
- R16B02
- R16B01


Installation
------------

To initialize the project run ``make bootstrap``.

To compile the module you simply run ``make``.

To run the unit tests run ``make test``.

To build the documentation run ``make doc``.

To enter a console where you can execute functions from the modules run ``make console``.


Usage
-----

Please check the unit tests in ``test/bstr_test.erl`` to see the list of
available functions and how to use them.