~reviewer/hello-hut

595fc0f47efad13fc9690626c0920249545bcdb1 — Noor Haddad 21 days ago e9c5dfa next
docs: document --lang
2 files changed, 6 insertions(+), 1 deletions(-)

M README.md
M docs/configuration.md
M README.md => README.md +4 -1
@@ 25,6 25,8 @@ $ hello-hut Ada --shout
HELLO, ADA!
$ hello-hut --time-of-day Grace
Good evening, Grace!
$ hello-hut --lang fr Ada
Bonjour, Ada!
```

## Options


@@ 37,6 39,7 @@ Good evening, Grace!
| `--count N` | Repeat the greeting `N` times | `1` |
| `--color WHEN` | `auto`, `always` or `never`; `NO_COLOR` is respected | `auto` |
| `--format FORMAT` | `text` or `json` | `text` |
| `--lang CODE` | Greeting language: `ar`, `de`, `en`, `es`, `fr`, `ja`, `pt`, `sv`, `tr` | `en` |

## Configuration



@@ 56,7 59,7 @@ Every key is described in [docs/configuration.md](docs/configuration.md).
- [x] Configuration file
- [x] `--count`, `--color` and `--format json`
- [x] Bash and zsh completions
- [ ] Localized greetings with `--lang`
- [x] Localized greetings with `--lang` (on the `next` branch)
- [ ] A man page
- [ ] ~~Rhyming greetings~~ (out of scope, see the tracker)


M docs/configuration.md => docs/configuration.md +2 -0
@@ 9,6 9,7 @@ win over the file.
| --- | --- | --- |
| `name` | string | Who to greet when no `NAME` is given |
| `shout` | boolean | Shout by default |
| `lang` | string | Default greeting language, e.g. `"fr"` |

Example:



@@ 16,6 17,7 @@ Example:
# ~/.config/hello-hut/config.toml
name = "Ada"
shout = false
lang = "fr"
```

## Notes