Skip to content

Commit

Permalink
docs(readme): add setup section
Browse files Browse the repository at this point in the history
  • Loading branch information
helmut-hoffer-von-ankershoffen committed Jan 2, 2025
1 parent 5035eef commit 0289c4d
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,22 @@

Brave Search Python Client supporting Web, Image, News and Video search.

## Setup

Installation is as simple as:

```bash
uv add brave_search_python_client
```

If you still prefer pip over [uv](https://github.com/astral-sh/uv):

```bash
pip install brave_search_python_client
```

## Highlights

* Modern async Python client for Web, Image, Video and News search powered by [Brave Search](https://brave.com/search/api/)
* Various Examples:
- [Streamlit web application](https://brave-search-python-client.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
Expand Down

0 comments on commit 0289c4d

Please sign in to comment.