> ## Documentation Index
> Fetch the complete documentation index at: https://gmlp.kdco.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install the package and set up the local development workflow.

## Runtime support

* Bun 1.3+
* Node.js 20.17+
* Browsers for pure parsing helpers
* Worker and edge runtimes that provide `fetch`

## Install the package

```bash theme={null}
# Bun
bun add google-maps-link-parser

# npm
npm install google-maps-link-parser

# pnpm
pnpm add google-maps-link-parser
```

## Install the repo locally

```bash theme={null}
bun install
```

If you are bootstrapping the repository for the first time and the lockfile is missing, create it once with:

```bash theme={null}
bun install --save-text-lockfile --lockfile-only
```

## Common commands

```bash theme={null}
bun run build
bun run check
bun run test
bun run docs:dev
```

<Tip>
  Use `bun run check` before opening a PR. It runs format checks, linting, type checking,
  and tests in a deterministic order.
</Tip>