# Universe

A high-energy logic toolkit for experimenting with computational ontology in
Elixir.

## Installation

After the package is published to Hex.pm, add `universe` to your dependencies:

```elixir
def deps do
  [
    {:universe, "~> 0.1.0"}
  ]
end
```

Documentation will be published to HexDocs with the package:
<https://hexdocs.pm/universe>.

## Publishing

Hex.pm publishing is configured in `mix.exs`.

Before the first release, register or authenticate with Hex locally:

```sh
mix hex.user register
```

For local publication, verify the package and then publish it:

```sh
mix deps.get
mix test
mix docs
mix hex.publish --dry-run
mix hex.publish
```

For GitHub Actions publication, create a Hex API key:

```sh
mix hex.user key generate --key-name publish-ci --permission api:write
```

Add the generated key as a GitHub repository secret named `HEX_API_KEY`. To
publish from CI, bump the version in `mix.exs`, update `CHANGELOG.md`, create a
matching tag such as `v0.1.0`, and push the tag.