Skip to content

Commit d57abb9

Browse files
committed
add readme for pypi package
1 parent 0c40f9d commit d57abb9

File tree

2 files changed

+31
-2
lines changed

2 files changed

+31
-2
lines changed

README_PY.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# externkit
2+
3+
A Python extension for external environment utilities built with Rust.
4+
5+
## Features
6+
7+
- Fast environment variable access
8+
- Cross-platform support
9+
- Built with Rust for performance
10+
11+
## Installation
12+
13+
```bash
14+
pip install externkit
15+
```
16+
17+
## Usage
18+
19+
```python
20+
import externkit
21+
22+
# Get an environment variable
23+
value = externkit.env.get("HOME")
24+
print(value)
25+
```
26+
27+
## License
28+
29+
MIT License

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ build-backend = "maturin"
55
[project]
66
name = "externkit"
77
version = "0.1.0"
8-
description = "A Python extension for externkit"
9-
readme = "README.md"
8+
description = "A Python extension for external environment utilities"
9+
readme = {file = "README_PY.md", content-type = "text/markdown"}
1010
license = {file = "LICENSE"}
1111
authors = [
1212
{name = "externref"},

0 commit comments

Comments
 (0)