Quick Start Guide

Installation

Install the package using your preferred package manager:

npm install our-package

yarn add our-package

pnpm add our-package

Basic Setup

1. Initialize your project:

import { initialize } from "our-package";

const app = initialize({
apiKey: "your-api-key",
environment: "development",
});

const { initialize } = require("our-package");

const app = initialize({
  apiKey: "your-api-key",
  environment: "development",
});

2. Configure your settings:

app.configure({
  theme: "light",
  language: "en",
  debug: true,
});

3. Start using the features:

// Your first API call
const result = await app.getData();
console.log(result);

Verification

To verify everything is working correctly:

npm test

yarn test

pnpm test

You should see output similar to:

✅ All tests passed
✅ Configuration valid
✅ Ready to use!

Next Steps

Now that you’re set up, explore these topics:

• Configuration Options
• API Reference
• Examples

Common Issues

Problem: “API key not found”
Solution: Make sure you’ve set your API key in the configuration.

Problem: “Module not found”
Solution: Ensure you’ve installed all dependencies with your package manager.