# Free Use Bible SDK

Add Bible text to your website or web app without having to worry about licensing and legal issues surrounding Bible text.

This is a type-safe Bible SDK to use in your web apps and websites.

## Installation

```bash
npm install free-use-bible-sdk
```

## Usage

```ts
import { FreeUseBibleSDK } from "free-use-bible-sdk";

const client = new FreeUseBibleSDK({
  baseUrl: "https://bible.helloao.org/",
});

const chapterResponse = await client.general.getChapterFromTranslation(
  "BSB",
  "Romans",
  8,
);
console.log(chapterResponse);
```

OpenAPI spec _(created based on [these docs](https://bible.helloao.org/docs/reference/))_ + [apigen-ts](https://github.com/vladkens/apigen-ts) = `FreeUseBibleSDK`

Bible text comes from the [Free Use Bible API](https://bible.helloao.org/), generously provided by [AO Lab](https://www.helloao.org/).

## API Overview

The SDK provides access to Bible translations and commentaries through the following methods:

### Translations
- `getAvailableTranslations()` - Get list of available Bible translations
- `getBooksForTranslation(translation: string)` - Get books for a specific translation
- `getChapterFromTranslation(translation: string, book: string, chapter: number)` - Get chapter content

### Commentaries
- `getAvailableCommentaries()` - Get list of available commentaries
- `getBooksForCommentary(commentary: string)` - Get books for a commentary
- `getChapterFromCommentary(commentary: string, book: string, chapter: number)` - Get commentary chapter
- `getProfilesForCommentary(commentary: string)` - Get profiles for a commentary
- `getProfileFromCommentary(commentary: string, profile: string)` - Get specific profile content

All methods return typed responses with full TypeScript support.

[Let me know how I can make it better.](https://cameronpak.com/contact)

— [Cam](https://cameronpak.com/contact)