@alphabite/medusa-collection-images/README.md

Alphabite's Medusa Collection Images Plugin

# medusa-collection-images

## ⚠️ Version Compatibility

Please install the plugin version that matches your Medusa version:

| Medusa Version     | Plugin Version | Install Command                                         |
| ------------------ | -------------- | ------------------------------------------------------- |
| `2.14.*` and above | `latest`       | `npm install @alphabite/medusa-collection-images`       |
| `2.13.*`           | `0.3.4`        | `npm install @alphabite/medusa-collection-images@0.3.4` |
| Below `2.13.0`     | `0.3.3`        | `npm install @alphabite/medusa-collection-images@0.3.3` |

### Installation

Install the latest version (Medusa `2.14.*`+):

```bash
npm install @alphabite/medusa-collection-images
```

```bash
yarn add @alphabite/medusa-collection-images
```

```bash
pnpm add @alphabite/medusa-collection-images
```

Install the latest version (Medusa `2.13.*`):

```bash
npm install @alphabite/medusa-collection-images@0.3.4
```

```bash
yarn add @alphabite/medusa-collection-images@0.3.4
```

```bash
pnpm add @alphabite/medusa-collection-images@0.3.4
```

Install version `0.3.3` (Medusa `< 2.13.*`):

```bash
npm install @alphabite/medusa-collection-images@0.3.3
```

```bash
yarn add @alphabite/medusa-collection-images@0.3.3
```

```bash
pnpm add @alphabite/medusa-collection-images@0.3.3
```

### Instructions

1. Check your installed Medusa version in `package.json` (look for `@medusajs/medusa`).
2. Install the matching plugin version using one of the commands above.
3. Register the plugin in your `medusa-config.ts` (or `medusa-config.js`):

   ```ts
   module.exports = defineConfig({
     // ...
     plugins: [
       {
         resolve: "@alphabite/medusa-collection-images",
         options: {},
       },
     ],
   });
   ```

4. Run database migrations:

   ```bash
   npx medusa db:migrate
   ```

5. Restart your Medusa server.