Skip to content

Commit

Permalink
Add installation instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
n2o committed Sep 5, 2024
1 parent c8f6c57 commit 6ce8159
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,21 @@

This library provides functions to interact with a Strapi v4 API and some more utilities.

## Installation

```bash
npm install @schnaq/strapi4-utils
# or
yarn add @schnaq/strapi4-utils
# or
pnpm install @schnaq/strapi4-utils
# ...
```

## Configuration

> [!NOTE]
> You need to configure environment variables if you want to interact with the Strapi API
> You need to configure environment variables if you want to interact with the Strapi API.
- `STRAPI_API_URL`: The URL of the Strapi API. Also looks up the public variable `NEXT_PUBLIC_STRAPI_API_URL` if you are using nextjs and are using a client component.
- `STRAPI_API_TOKEN`: The API token to authenticate with the Strapi API. Also looks up the public variable `NEXT_PUBLIC_STRAPI_API_TOKEN` if you are using nextjs and are using a client component.
Expand Down

0 comments on commit 6ce8159

Please sign in to comment.