Skip to content

Commit 8787ca9

Browse files
committed
chore: minor readme updates
1 parent d4d8506 commit 8787ca9

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,16 @@ Exportify offers a simple rule-based system for enforcing `__all__` and `__init_
2727

2828
## Installation
2929

30+
Easiest to install with [`uv`](https://docs.astral.sh/uv/getting-started/installation/):
31+
32+
```bash
33+
uv tool install exportify
34+
```
35+
36+
or `pipx`:
37+
3038
```bash
31-
pip install exportify
39+
pipx install exportify
3240
```
3341

3442
Python 3.12+ required.
@@ -69,7 +77,7 @@ exportify status
6977
|----------|-------------|
7078
| [CLI Reference](docs/cli-reference.md) | Complete command reference with all flags |
7179
| [Rule Engine](src/exportify/rules/README.md) | Rule syntax, priorities, match criteria, provenance |
72-
| [Configuration](docs/init.md) | Initialising and configuring exportify |
80+
| [Configuration](docs/init.md) | Initializing and configuring exportify |
7381

7482
### Guides
7583

@@ -210,7 +218,7 @@ Everything above the sentinel is left untouched on every `fix` or `generate` run
210218
| `exportify generate` | Bootstrap new `__init__.py` files for packages missing one |
211219
| `exportify status` | Show current export/import health status |
212220
| `exportify doctor` | Run health checks and provide actionable advice |
213-
| `exportify init` | Initialise exportify with a default config file |
221+
| `exportify init` | Initialize exportify with a default config file |
214222
| `exportify clear-cache` | Clear the analysis cache |
215223

216224
See the [full CLI reference](docs/cli-reference.md) for all flags and options.

0 commit comments

Comments
 (0)