@qbraid-core/devices/README.md

Client for the qBraid Quantum Devices service.

<img align="right" width="100" alt="qbraid" src="https://qbraid-static.s3.amazonaws.com/logos/qbraid.png">

# [@qbraid-core/devices](https://qbraid.github.io/qbraid-core-js/modules/_qbraid-core_devices.html)

[![Stable][preview-stability]](https://qbraid.github.io/qbraid-core-js/#launch-stages)
[![npm](https://img.shields.io/npm/v/@qbraid-core/devices?color=blue)](https://npm.im/@qbraid-core/devices)

Client for the qBraid Quantum Devices service.

## Installation

```bash
npm install @qbraid-core/devices
```

## Usage Example

### V2 API (Recommended)

```typescript
import { QbraidSessionV1 } from '@qbraid-core/base';
import { QuantumDevicesClientV1 } from '@qbraid-core/devices';

const session = new QbraidSessionV1('your-api-key');
const client = new QuantumDevicesClientV1(session);

const devices = await client.getDevices();

devices.forEach(device => console.log(`${device.qrn} - ${device.status}`));
```

### V1 API (Legacy)

```typescript
import { QuantumDevicesClient } from '@qbraid-core/devices';

const client = new QuantumDevicesClient();

const devices = await client.getDevices();

devices.forEach(device => console.log(`${device.qbraid_id} - ${device.status}`));
```

## License

This software is proprietary and subject to the terms of the [qBraid Commercial Software License](https://qbraid.github.io/qbraid-core-js/#license).

[stable-stability]: https://img.shields.io/badge/stability-stable-green
[preview-stability]: https://img.shields.io/badge/stability-preview-orange
[deprecated-stability]: https://img.shields.io/badge/stability-deprecated-red