ChonkOMeter

This library was used as an example of how to create livebook documentation. It accompanies this blog post.

Chonk O Meter is a state of the art size estimator. It will rate the size of anything according to the following chart:

For example:

iex> ChonkOMeter.story_points(10)
"Mega Chonk"

Generating Docs

Generate with:

mix docs

Publish

mix hex.publish

Installation

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

def deps do
  [
    {:chonk_o_meter, "~> 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/chonk_o_meter.