Skip to content

Commit 725604e

Browse files
committed
chore: update readme
1 parent 23c6196 commit 725604e

File tree

2 files changed

+24
-11
lines changed

2 files changed

+24
-11
lines changed

.github/workflows/CI.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ on:
1212
pull_request:
1313
workflow_dispatch:
1414

15+
concurrency:
16+
group: ${{ github.workflow }}-${{ github.ref }}
17+
cancel-in-progress: true
18+
1519
permissions:
1620
contents: read
1721

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,35 @@ This is a proof of concept draft, to test scripting utilities using stack-graphs
88

99
It uses pyo3 and maturin to generate the bindings.
1010

11-
## Ressources
11+
## Installation & Usage
1212

13-
https://pyo3.rs/v0.21.2/getting-started
14-
15-
## Setup
13+
```bash
14+
pip install stack-graphs-python-bindings # or poetry, ...
15+
```
1616

17-
TODO
17+
```python
18+
from stack_graphs_python import index, query_definition, Position
1819

19-
```bash
20-
pipx install maturin
20+
# ...
2121
```
2222

23+
You can refer to the example in [test/test.py](https://github.com/nohehf/stack-graphs-python-bindings/blob/main/tests/test.py) for a concrete usage example.
24+
2325
## Development
2426

25-
TODO
27+
### Ressources
28+
29+
https://pyo3.rs/v0.21.2/getting-started
30+
31+
### Setup
2632

2733
```bash
28-
maturin develop
34+
pipx install maturin # or pip, ...
2935
```
3036

31-
## Install
37+
### Testing
3238

33-
TODO
39+
```bash
40+
maturin develop
41+
python tests/test.py
42+
```

0 commit comments

Comments
 (0)