Skip to content

Commit

Permalink
add pypi doc
Browse files Browse the repository at this point in the history
  • Loading branch information
aksiome committed Mar 6, 2025
1 parent 62286a7 commit 62a1065
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,32 @@ Please note that while the datapacks from releases are stable, they might not in

If you like the project, don't hesitate to star it on Github and/or follow it on Modrinth 😉.

::::
::::{tab-item} 🐍 from PyPI

If you're using the [beet](https://github.com/mcbeet/beet) build pipeline, you can install the Bookshelf package (`mcbookshelf`) from PyPI to include Bookshelf modules in your build.

```shell
pip install mcbookshelf
```

Once installed, you can reference Bookshelf modules directly in your beet pipeline configuration.

To include a specific module:
```yaml
pipeline:
- bookshelf.module.raycast
- bookshelf.module.<name_of_other_module>
```
To include a full bundle:
```yaml
pipeline:
- bookshelf.bundle.dev
- bookshelf.bundle.<name_of_other_bundle>
```
::::
::::{tab-item} 🗃️ from source
Expand Down

0 comments on commit 62a1065

Please sign in to comment.