https://github.com/adzz/chonk_o_meter
https://github.com/adzz/chonk_o_meter
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/adzz/chonk_o_meter
- Owner: Adzz
- Created: 2022-04-05T07:29:41.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-09T14:21:00.000Z (over 4 years ago)
- Last Synced: 2025-04-19T18:08:42.087Z (over 1 year ago)
- Language: Elixir
- Size: 62.5 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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:
```sh
mix docs
```
## Publish
```sh
mix hex.publish
```
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `chonk_o_meter` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:chonk_o_meter, "~> 0.1.0"}
]
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/chonk_o_meter](https://hexdocs.pm/chonk_o_meter).