vek-engine/README.md

Efficient WebAssembly-based vector math engine for JavaScript/TypeScript

# Vek Engine (`vek-engine`)

> Efficient WebAssembly-based vector math engine for JavaScript/TypeScript

## Installation

To install **Vek Engine**, run:

```bash
npm i --save vek-engine
```

## Usage

```typescript
import Vector from 'vek-engine'
import {createClassFactory} from 'vek-engine'
import {v} from 'vek-engine'
import {Vector} from 'vek-engine'
import type {VectorModalityT} from 'vek-engine'
import {VectorModalityType} from 'vek-engine'
import type {VectorOptionsT} from 'vek-engine'
import {VectorPrecision} from 'vek-engine'
```

Check out [the tests](src/vector.test.mts) for usage examples

## Author

Jonathan Barronville

## License

`MPL-2.0` (_Mozilla Public License 2.0_)