README.md

Nebula

Nebula is a small library for colored (ANSI) output in Erlang/Elixir. It's can be useful when you need to create user-friendly command-line application.

Installation

Just add {nebula, "0.1.1"} to your rebar.config file and run following command:

➜ ~ make compile

or if you want to use this package with Elixir add {:nebula, "~> 0.1.1"} to your mix.exs and run following command:

➜ ~ mix deps.get

Usage

Using with Erlang:

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

Using with LFE (Lisp Flavoured Erlang):

(defun update_something ()
    (nebula:print :GREEN "Something has been updated successfully!"))

Using with Elixir:

def update_something do
  # ...
  # ...
  :nebula.print(:green, "Something has been updated successfully!")
end

Available functions and colors

First argument is color name (atom), second - your message.

• print/2: black, red, green, orange, blue, purple, yellow, cyan, grey.
• background/2: black, red, green, yellow, blue, purple, cyan.

License

BSD 3-Clause License