Skip to content

Commit edff57e

Browse files
authored
docs: add installation guide and link GitHub Issues (#40)
1 parent d4183bf commit edff57e

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs.py

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,14 @@ def _(mo):
3030
3131
Powered by [`narwhals`](https://narwhals-dev.github.io/narwhals/).
3232
33+
## Installation
34+
35+
Install from PyPI with:
36+
37+
```terminal
38+
uv add frame-search
39+
```
40+
3341
## Features
3442
3543
By importing `frame_search`, DataFrames gain a `search` method that
@@ -159,6 +167,23 @@ def _(default, df, mapping_to_columns, mo, search):
159167
return
160168

161169

170+
@app.cell
171+
def _(mo):
172+
mo.md(
173+
"""
174+
175+
Using `frame-search` along visualization libraries can help quickly point out
176+
interesting subsets of data.
177+
178+
## Additional Information
179+
180+
If you encounter any issues or have feature requests, please open an issue on [GitHub](https://github.com/williambdean/frame-search/issues/new). Thanks!
181+
182+
"""
183+
)
184+
return
185+
186+
162187
@app.cell
163188
def _():
164189
return

0 commit comments

Comments
 (0)