# Smokkfiskur

[![Build Status](https://travis-ci.org/lk-geimfari/smokkfiskur.svg?branch=master)](https://travis-ci.org/lk-geimfari/smokkfiskur)
[![Hex.pm](https://img.shields.io/hexpm/v/plug.svg)](https://hex.pm/packages/smokkfiskur)
[![BSD](https://img.shields.io/pypi/l/Django.svg?maxAge=2592000)](https://github.com/lk-geimfari/smokkfiskur/blob/master/LICENSE)

<p align="center">
  <img src="https://raw.githubusercontent.com/lk-geimfari/smokkfiskur/master/other/logo2.png">
</p>
---------

__Smokkfiskur__ is a small library for colored (ANSI) output in Erlang. It's can be useful when you need to create a command-line applications.


### Installation
Make sure, that `rebar3` installed and configured in your OS and add `{deps, [{smokkfiskur, "0.1.3"}]}.` to your `rebar.config` now run the following command:

```
➜ ~ rebar3 compile
```


### Usage
Just use the following format `print(color, "Text").`

```erlang
smokkfiskur:print(red, "Red text").
```
---------
### Example
```erlang
-import(smokkfiskur, [print/2]).

update_something() ->
  %% ...
  %% ...
  %% ...
  print(green, "Something has been updated successfully!").
```
or

```erlang
-import(smokkfiskur, [print/2]).


%%=========================
%% Text
%%=========================
print(red,    "Text").
print(black,  "Text").

%%=========================
%% Background
%%=========================


background(red,    "Text").
background(black,  "Text").
```
### Screenshot

[Here](https://raw.githubusercontent.com/lk-geimfari/smokkfiskur/master/other/screen.png) you can find screenshot.