@qyrus/journeys/README.md

Record and replay user journeys with continuous streaming.

# Qyrus Journeys

## Overview

The **Qyrus Journeys** package is a lightweight JavaScript library designed to help Qyrus understand user navigation patterns, enhancing your QA testing experience. This library captures user interactions to provide actionable insights that improve your tests, identify potential user experience issues and optimize QA workflows all while maintaining privacy standards.

### Key Features

🎯 **User Journey Insights** – Analyze user navigation paths and interaction sequences  
📊 **Enhanced Test Coverage** – Generate insights to strengthen your QA processes  
🔄 **Workflow Understanding** – Uncover common user patterns to optimize testing strategies  
🛡️ **Privacy-First Design** – Automatically masks and anonymizes all input data  
⚡ **Simple Integration** – Quick set up and configuration, with flexible framework support

By prioritizing data privacy, Qyrus Journeys ensures all input data is masked, while still delivering valuable insights to support your quality assurance processes.

## Installation

Install the package from npm:

```bash
npm install @qyrus/journeys
```

or using Yarn:

```bash
yarn add @qyrus/journeys
```

## Usage (JavaScript)

```javascript
import { QyrusJourneys } from '@qyrus/journeys';

// Initialize the package
QyrusJourneys.init({
  apiKey: 'your-api-key-here'
});
```

## Framework Configuration

For step-by-step setup instructions with popular frameworks—including Angular, Next.js, Svelte, Vue.js, and more—refer to our [comprehensive configuration documentation](https://docs.qyrus.com/aiverse/qyrusjourneysconfig).