docs: embedder-segment quick start (#26)

[karlwaldman]

Addresses the README half of #26.

"Beyond Oil — Gas, LNG, Carbon & Fuels"

New compact section immediately after the Quick Start example (Brent/WTI stays first). Three runnable TypeScript examples using the real typed surface:

• client.futures.euaCarbon().latest() — EU ETS carbon (EUA) front month
• client.futures.ttfGas().latest() — Dutch TTF, with the other family helpers (.lngJkm(), .naturalGas(), .ukCarbon(), ...) called out
• client.getLatestPrices({ commodity: "VLSFO_USD" }) / "JET_FUEL_USD" — marine + aviation fuel spot

One sentence names the audiences: maritime compliance (EU ETS / FuelEU Maritime), fleet & logistics fuel costing, LNG/European gas analytics, CBAM reporting. Closes with the remaining spot codes (EU_CARBON_EUR, DUTCH_TTF_EUR, JKM_LNG_USD, DIESEL_USD, NATURAL_GAS_USD) and a pointer to client.bunkerFuels, plus a tier note (futures/bunker endpoints are plan-gated, spot works on every tier).

Notes on accuracy:

• Helper names verified in src/resources/futures.ts (ttfGas, lngJkm, euaCarbon, ukCarbon all exist and return FuturesContractFamily with .latest()); front_month?.last_price matches the FuturesPrice / FuturesContractMonth types.
• Commodity codes verified against the backend commodities config.
• I deliberately used spot codes rather than client.bunkerFuels.port() for the VLSFO example: the SDK's PortBunkerPrices.prices type is a keyed object (prices.VLSFO), but the live API returns prices as an array of {grade, price, unit} records — a keyed-access example would type-check yet print undefined. Worth a follow-up issue to fix the type.
• No fabricated price values — placeholder shapes only.

Open question for Karl (from #26)

The 1.0.0 version bump is intentionally NOT included — that call is Karl's. Current version stays 0.10.0; #26 remains open for the versioning decision.

Verification

• npm test: 422 passed, 1 skipped (28 files)

🤖 Generated with Claude Code

[coderabbitai]

Warning

Review limit reached

@karlwaldman, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 38 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fa182fd6-1738-4864-8d05-0a167955767a

📥 Commits

Reviewing files that changed from the base of the PR and between ac214d2 and 6ef9ddd.

📒 Files selected for processing (1)

• README.md

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/embedder-quickstart

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}