Skip to content

Commit e997c4b

Browse files
committed
update readme for jupyter
1 parent 4397a45 commit e997c4b

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,15 +75,29 @@ summary, tree, content = ingest("path/to/directory")
7575

7676
# or from URL
7777
summary, tree, content = ingest("https://github.com/cyclotruc/gitingest")
78+
```
79+
80+
By default, this won't write a file but can be enabled with the `output` argument.
7881

82+
```python
7983
# Asynchronous usage
8084
from gitingest import ingest_async
8185
import asyncio
8286

8387
result = asyncio.run(ingest_async("path/to/directory"))
8488
```
8589

86-
By default, this won't write a file but can be enabled with the `output` argument.
90+
### Jupyter notebook usage
91+
92+
```python
93+
from gitingest import ingest_async
94+
95+
# Use await directly in Jupyter
96+
summary, tree, content = await ingest_async("path/to/directory")
97+
98+
```
99+
100+
This is because Jupyter notebooks are asynchronous by default.
87101

88102
## 🐳 Self-host
89103

0 commit comments

Comments
 (0)