# About roamgap

> roamgap is a smart holiday optimizer. Give it a country and a PTO budget, and
> it finds the calendar trips that turn the fewest leave days into the most
> continuous time off.

## What it does

A Tuesday public holiday plus the weekends around it can give a 5-day break for
two days of PTO. roamgap surfaces these opportunities automatically, ranked by
efficiency (total days off ÷ PTO days spent).

- **Annual planner** — https://roamgap.ike.work/year — plans your whole year from a yearly
  PTO budget, returning five alternative year plans.
- **Calendar** — https://roamgap.ike.work/calendar — a country's weekends and public
  holidays for any year, with no optimization.

The core optimizer is free and complete, including regional (state/province)
accuracy where we have the data.

## Where to go next

- [How it works](https://roamgap.ike.work/about/how-it-works.md): efficiency, trips, bridge
  days, the five plan strategies, budget mode, regions, holidays.
- [How trips are scored](https://roamgap.ike.work/about/algorithm.md): the efficiency
  formula and worked examples.
- [URL format](https://roamgap.ike.work/about/url-format.md): how to construct optimizer
  URLs by hand.
- [Project specification](https://roamgap.ike.work/about/spec.md): the product brief.
- [Public stats](https://roamgap.ike.work/about/stats.md): top-line analytics aggregates.
- [Data licence](https://roamgap.ike.work/about/license.md): the open terms the data is
  offered under.

## For AI agents

Every content page has a Markdown twin (append `.md`), and the API publishes
JSON Schema and OpenAPI. Start at https://roamgap.ike.work/llms.txt for the curated index, or
https://roamgap.ike.work/llms-full.txt for the whole documentation set in one file.

## Privacy

Analytics run only after consent. See https://roamgap.ike.work/legal/privacy.