@quenty/qframe/README.md

CFrame representation as a quaternion for Roblox

## QFrame
<div align="center">
  <a href="http://quenty.github.io/NevermoreEngine/">
    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
  </a>
  <a href="https://discord.gg/mhtGUS8">
    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
  </a>
  <a href="https://github.com/Quenty/NevermoreEngine/actions">
    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
  </a>
</div>

CFrame representation as a quaternion

<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/QFrame">View docs →</a></div>

## Installation
```
npm install @quenty/qframe --save
```

## Usage

QFrames are CFrames but as quaternions. This lets them be put into a spring in a linear fashion. While you can't really treat a quaternion in a linear way, this is close enough.