# hello-hut

![hello-hut logo](docs/images/logo.png)

**hello-hut** is a small, friendly greeting tool for your terminal. It says
hello — and that is all it does.

## Installation

```sh
pip install hello-hut
```

See [docs/install.md](docs/install.md) for other ways to install it,
including running straight from a checkout.

## Usage

```console
$ hello-hut
Hello, friend!
$ hello-hut Ada
Hello, Ada!
$ hello-hut Ada --shout
HELLO, ADA!
$ hello-hut --time-of-day Grace
Good evening, Grace!
```

## Configuration

Defaults can live in `~/.config/hello-hut/config.toml`:

```toml
name = "Ada"
shout = false
```

Every key is described in [docs/configuration.md](docs/configuration.md).

## License

MIT — see [LICENSE](LICENSE).