Skip to content

docs(python): add pre-release PyPI warning #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Patel230 merged 1 commit into from
Jul 22, 2026
Merged

docs(python): add pre-release PyPI warning #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,23 @@ the same API surface on each.

## Installation

```bash
pip install hawk-sdk
```
> **⚠️ Pre-release — not yet published to PyPI.**
>
> `hawk-sdk` is under active development and has not yet been published to
> the Python Package Index. Installing from PyPI will fail until a stable
> release is tagged. In the meantime, install directly from source:
>
> ```bash
> git clone https://github.com/GrayCodeAI/hawk-sdk-python.git
> cd hawk-sdk-python
> pip install -e .
> ```
>
> Once the first stable release is tagged, the standard install will work:
>
> ```bash
> pip install hawk-sdk # available after first stable release
> ```

## Quick Start

Expand Down
Loading