@qbraid-core/base/README.md

Core functionality for interacting with qBraid Cloud Services.

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

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

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

Base API client used for authentication, requests, and other core functionality for interacting with qBraid Cloud Services.

## Installation

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

## Usage Example

### V1 API (Recommended)

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

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

// The session client is ready to use immediately
console.log('Session initialized:', session.client !== null);
```

### V0 API (Legacy)

```typescript
import { QbraidClient } from '@qbraid-core/base';

const client = new QbraidClient();

const user = await client.getUser();

console.log(`email: ${user.email}`, `role: ${user.role}`);
```

## 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