shortest-path/README.md

A TypeScript library that implements the A* (A-star) pathfinding algorithm to find the shortest path on a grid.

# Shortest Path

A lightweight TypeScript utility for generating the shortest path on a grid, or an empty array if there is no path.

## 📦 Installation

```bash
npm install shortest-path
```


## 🚀 Usage

Examples can be found in the tests for this repo repo

## ⚙️ API

### `shortestPath(grid: Grid): Position[]`