Skip to content

Commit 8a91922

Browse files
committed
docs: descriptive installation guide
1 parent 11618d0 commit 8a91922

3 files changed

Lines changed: 22 additions & 18 deletions

File tree

docs/quickstart.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,29 @@ It is intentionally short. The goal is to get you productive quickly, not to exp
1010

1111
Install the package using your preferred tool.
1212

13-
With pip:
13+
- Standard installation (uses `uuid6` library):
1414

15-
```bash
16-
pip install typeid-python
17-
```
15+
```console
16+
$ pip install typeid-python
17+
```
1818

19-
With uv:
19+
- Rust acceleration (`uuid-utils` + Rust base32 encode/decode):
2020

21-
```bash
22-
uv add typeid-python
23-
```
21+
```console
22+
$ pip install "typeid-python[rust]"
23+
```
2424

25-
If you plan to use YAML schemas later, install the optional extra:
25+
- YAML schemas support:
2626

27-
```bash
28-
pip install "typeid-python[yaml]"
29-
```
27+
```console
28+
$ pip install "typeid-python[yaml]"
29+
```
30+
31+
- CLI features:
32+
33+
```console
34+
$ pip install "typeid-python[cli]"
35+
```
3036

3137
JSON schemas work without any extras.
3238

pyproject.toml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,7 @@ dependencies = ["uuid6>=2024.7.10,<2026.0.0"]
2727
[project.optional-dependencies]
2828
cli = ["click"]
2929
yaml = ["PyYAML"]
30-
rust = [
31-
"uuid-utils>=0.12.0",
32-
"maturin>=1.5; platform_system != 'Windows'", # optional; for local dev only
33-
]
30+
rust = ["uuid-utils>=0.12.0"]
3431

3532
[project.urls]
3633
Homepage = "https://github.com/akhundMurad/typeid-python"
@@ -57,6 +54,7 @@ dev = [
5754
"mkdocs-section-index>=0.3.10",
5855
"pytest-markdown-docs>=0.9.0",
5956
"pytest-benchmark>=5.0.1",
57+
"maturin>=1.5; platform_system != 'Windows'"
6058
]
6159

6260
[tool.hatch.build.targets.sdist]

uv.lock

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)