Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 1.73 KB

README.md

File metadata and controls

47 lines (34 loc) · 1.73 KB
Raw

Cowrie

Module Version Hex Docs Total Download License Last Updated

Cowrie helps you print beautiful and consistent Terminal output to the Shell of your Elixir apps using functions inspired by familiar HTML tags, e.g.

import Cowrie

h1("This is a Heading")
ol(["This is", "an ordered", "list via ol/2"])
warning("Uh oh...")

All formatting is configurable, either via your application's configuration file, or as arguments to the various functions. Sensible defaults are provided. Try running the Cowire/demo/0 function to inspect the styling of all the output.

All formatting styles rely on IO.ANSI formatting options, so you are free to research and apply your own styles to match your personal preference.

Installation

If available in Hex, the package can be installed by adding cowrie to your list of dependencies in mix.exs:

def deps do
  [
    {:cowrie, "~> 0.1.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/cowrie.

Image Attribution

The logo image is Cowry by Amos Kofi Commey from the Noun Project