This library adds help documentation to iex.
This allows the user to have topics and reference materials in one place without having to know exactly which package to find it in. This project is at an early stage and would welcome contributions.
Once you have installed about then you can use:
iex> h About.regex
If available in Hex, the package can be installed
by adding about to your list of dependencies in mix.exs:
def deps do
[
{:about, "~> 0.0.1"}
]
endDocumentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/about.
This library adds nothing to production code just extra documentation in iex.