diff --git a/README.md b/README.md index 56a3540..2f8fc3e 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,98 @@ -# Tern — Travel Planning & Disruption Management +
-> *Part of the Circuit Forge LLC "AI for the tasks you hate most" suite.* +# Tern -**Status:** Backlog — not yet started. Peregrine must prove the model first. +**Local-first travel assistant. Flight and hotel monitoring, itinerary generation, visa research, and disruption recovery — no cloud required.** + +[![Status](https://img.shields.io/badge/status-backlog-lightgrey)](https://git.opensourcesolarpunk.com/Circuit-Forge/tern) +[![License](https://img.shields.io/badge/license-BSL%201.1-blue)](LICENSE) +[![CircuitForge](https://img.shields.io/badge/CircuitForge-LLC-green)](https://circuitforge.tech) + +[Website](https://circuitforge.tech) · [Roadmap](https://git.opensourcesolarpunk.com/Circuit-Forge/roadmap) · [All Products](https://circuitforge.tech/#products) + +
+ +--- + +> *Part of the [Circuit Forge LLC](https://circuitforge.tech) menagerie — AI for the tasks the system made hard on purpose.* + +**Status:** Backlog — not yet started. See the [roadmap](https://git.opensourcesolarpunk.com/Circuit-Forge/roadmap) for priority order. ## What it does Tern handles travel from planning to recovery: flight and hotel monitoring, itinerary generation, visa requirement research, travel insurance comparison, and rebooking assistance when things go wrong. -The Arctic tern makes the longest migration of any animal — 44,000 miles per year, pole to pole and back — every single year. The world's greatest traveler. +The Arctic tern (Sterna paradisaea) makes the longest migration of any animal: roughly 44,000 miles per year, pole to pole and back, every single year. The world's most experienced traveler. It does not get confused in new airports. -## Why it's hard +## Why it is hard -Travel is hard because: -- Price volatility: the same flight can vary 3× in cost over 72 hours +Travel planning fails in predictable ways: + +- Price volatility: the same flight can vary three times in cost over 72 hours - Visa requirements are country-specific, citizenship-specific, and change without notice -- Disruption recovery is time-critical: rebooking windows close fast, compensation rules are complex -- Travel insurance policies are dense and full of exclusions +- Disruption recovery is time-critical: rebooking windows close fast and compensation rules are jurisdiction-specific and complex +- Travel insurance policies are dense and full of exclusions that are only visible at claim time ## Core pipeline ``` Configure trip parameters (destination, dates, budget, constraints) -→ Monitor flights / hotels → Alert on price drops or availability -→ Generate itinerary → Visa + entry requirement check -→ Travel insurance comparison → Book (or route to Ultra operator) -→ On disruption: rebook options + compensation claim draft + → Monitor flights and hotels → Alert on price drops or availability changes + → Generate itinerary → Visa and entry requirement check + → Travel insurance comparison → Human confirms booking + → On disruption: present rebook options and draft compensation claim + → Track claim status ``` -## Key differentiators vs. Peregrine +## Feature areas -- Real-time price monitoring vs. batch discovery -- Disruption response is time-critical (minutes, not hours) -- Compensation claims: EU261, DOT rules, airline contract of carriage -- Visa research: country + citizenship + trip purpose = requirements matrix +- **Price monitoring**: watch specific routes and date ranges; alert when price crosses your threshold +- **Itinerary builder**: structured trip plan with confirmation numbers, addresses, and local transit notes +- **Visa matrix**: your citizenship plus destination plus trip purpose gives you current requirements, processing times, and document checklist +- **Disruption kit**: flight delay or cancellation triggers a guided workflow: your rights under EU261 or DOT rules, rebook options, and a pre-drafted compensation claim letter +- **Insurance comparison**: policy summary in plain language with exclusion flags before you buy +- **Offline mode**: your itinerary and key documents are available without connectivity -## Product code (license key) +## Privacy · Safety · Accessibility -`CFG-TERN-XXXX-XXXX-XXXX` +**Privacy:** Itinerary data and passport details stay local. Visa requirement lookups use jurisdiction-specific official sources without sending your personal details to third parties. + +**Safety:** Visa and entry requirement information is sourced from official government databases and flagged with the date it was last verified. Requirements change; Plover always recommends confirming with the official embassy or consulate before travel. + +**Accessibility:** Itineraries export to accessible formats (plain text, screen-reader-friendly HTML, iCal). Time zones are displayed in both local and home time to reduce disorientation. Large-text mode for passport and boarding pass scanning. + +## Tiers + +| Tier | What you get | +|------|-------------| +| **Free** | Itinerary builder, visa matrix, local LLM disruption guidance, offline itinerary access | +| **Paid** | Real-time price monitoring and alerts, email sync for booking confirmations, compensation claim tracking, cloud sync across devices | +| **Premium** | Multi-traveler household support, fine-tuned disruption response model, insurance policy analysis | + +## Get involved + +Tern is pre-development. The best thing you can do right now is open an issue with: + +- A travel disruption scenario where you felt unprepared or lost time figuring out your rights +- Visa or entry requirement situations that were harder to navigate than they should have been +- Data sources (flight APIs, official visa databases) you know are reliable +- Accessibility requirements for travel tools you want included from the start + +Early issues shape what gets built first. Star the repo to follow progress. + +## Product code + +License key format: `CFG-TERN-XXXX-XXXX-XXXX` ## Tech notes -- Shared `circuitforge-core` scaffold -- Flight data: Skyscanner API, Google Flights scrape, airline direct -- Visa requirements: travel.state.gov, IATA Travel Centre API -- EU261 / DOT compensation calculator -- Calendar integration: add itinerary items directly to user's calendar +- Built on the shared [circuitforge-core](https://git.opensourcesolarpunk.com/Circuit-Forge/circuitforge-core) scaffold +- Flight data: Skyscanner API, direct airline feeds +- Visa requirements: travel.state.gov, IATA Travel Centre API, embassy feeds +- EU261 / DOT compensation calculator: jurisdiction-keyed rules engine +- Calendar integration: iCal export for full itinerary +- Data format: SQLite local store; JSON export for portability + +## License + +[Business Source License 1.1](LICENSE) — free for personal non-commercial self-hosting. Converts to MIT after four years. Commercial use requires a [paid license](https://circuitforge.tech/pricing).