Skip to content

Lead SDK READMEs with package install steps #1

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

Open
sairin1202 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Lead SDK READMEs with package install steps #1

Show file tree
Hide file tree
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 js/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,27 @@ JavaScript SDK and CLI for the Boids API.

## Install

Install the SDK from npm:

```bash
npm install boids-sdk
```

Then set your API key:

```bash
curl -fsSL https://raw.githubusercontent.com/NevaMind-AI/boids-sdk/main/install.sh | bash
export BOIDS_API_KEY="..."
```

The installer tries `npm install -g boids-sdk` first, then falls back to pipx or
pip. Use `npm install boids-sdk` for a project-local SDK dependency.
Use environment variables in production rather than hard-coding API keys. With a
local install, you can also run the bundled CLI through `npx boids ...`.

To install the standalone `boids` CLI globally instead, use the bash installer
(it tries `npm install -g boids-sdk` first, then falls back to pipx or pip):

```bash
curl -fsSL https://raw.githubusercontent.com/NevaMind-AI/boids-sdk/main/install.sh | bash
```

## CLI

Expand Down
19 changes: 16 additions & 3 deletions python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,26 @@ Python SDK and CLI for the Boids API.

## Install

Install the SDK from PyPI:

```bash
pip install boids-sdk
```

Then set your API key:

```bash
curl -fsSL https://raw.githubusercontent.com/NevaMind-AI/boids-sdk/main/install.sh | bash
export BOIDS_API_KEY="..."
```

The installer tries npm first, then falls back to pipx or pip. Use
`pip install boids-sdk` when you only need the Python SDK dependency.
Use environment variables in production rather than hard-coding API keys.

To install the standalone `boids` CLI globally instead, use the bash installer
(it tries npm first, then falls back to pipx or pip):

```bash
curl -fsSL https://raw.githubusercontent.com/NevaMind-AI/boids-sdk/main/install.sh | bash
```

## CLI

Expand Down