docs(README): update quickstart and add title
This commit is contained in:
@@ -1,10 +1,17 @@
|
|||||||
[](https://git.klemek.fr/klemek/cool-domain/actions?workflow=lint.yml) [](https://git.klemek.fr/klemek/cool-domain/actions?workflow=test.yml)
|
[](https://git.klemek.fr/klemek/cool-domain/actions?workflow=lint.yml) [](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
|
```bash
|
||||||
# install with pip
|
# 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
|
# run with pipx
|
||||||
pipx run --spec git+https://git.klemek.fr/klemek/cool-domain cool-domain
|
pipx run --spec git+https://git.klemek.fr/klemek/cool-domain cool-domain
|
||||||
|
|||||||
Reference in New Issue
Block a user