From dcfe91453dd42309fc09e86a7f0f869949b5616b Mon Sep 17 00:00:00 2001 From: Klemek Date: Mon, 15 Jun 2026 11:30:25 +0200 Subject: [PATCH] docs(README): update quickstart and add title --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d1746cd..8515e52 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,17 @@ [![](https://git.klemek.fr/klemek/cool-domain/actions/workflows/lint.yml/badge.svg?branch=main&style=flat-square)](https://git.klemek.fr/klemek/cool-domain/actions?workflow=lint.yml) [![](https://git.klemek.fr/klemek/cool-domain/actions/workflows/test.yml/badge.svg?branch=main&style=flat-square)](https://git.klemek.fr/klemek/cool-domain/actions?workflow=test.yml) -## +# Cool Domain + +> Find a cool unclaimed domain names from the terminal + +## Quickstart + +Run either from python3, [pipx](https://pipx.pypa.io/stable/) or [uvx](https://docs.astral.sh/uv/guides/tools/) ```bash # install with pip -pip install git+https://git.klemek.fr/klemek/cool-domain +python3 -m pip install git+https://git.klemek.fr/klemek/cool-domain +python3 -m cool-domain # run with pipx pipx run --spec git+https://git.klemek.fr/klemek/cool-domain cool-domain