Skip to content

Commit

Permalink
feat: add requirements and configuration sections to package README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Adammatthiesen committed Jan 8, 2025
1 parent f213ecf commit 48afdb8
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions package/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ npm install astro-ghostcms-loader

## Usage

### Requirements

To use this loader, it is required that you be on at least Astro `v5.0.0`

Also make sure to create and set your `.env` file with the following:
Expand All @@ -18,6 +20,8 @@ Also make sure to create and set your `.env` file with the following:
GHOST_CONTENT_API_KEY=your_api_key_here
```

### Config

In `src/content.config.ts`, import and configure the loaderCollection:

```ts
Expand All @@ -31,6 +35,8 @@ export const collections = {
}
```

### Calling the created GhostCMS collections

[Query the content collection](https://docs.astro.build/en/guides/content-collections/#querying-collections) like any other Astro content collection entry:

```ts
Expand Down

0 comments on commit 48afdb8

Please sign in to comment.