Skip to content

docs: registry storefront README + v1.0.1#31

Merged
karlwaldman merged 3 commits into
mainfrom
docs/registry-storefront
Jul 3, 2026
Merged

docs: registry storefront README + v1.0.1#31
karlwaldman merged 3 commits into
mainfrom
docs/registry-storefront

Conversation

@karlwaldman

Copy link
Copy Markdown
Member

Summary

Applies the shared "registry storefront" marketing formula (shipped in the PHP SDK README) to the Node SDK, and bumps the version so npm re-renders the README on publish.

  • Hero: real-time oil/gas/LNG/carbon/fuel prices in under 60 seconds; audiences (fintech dashboards, fleet & logistics, maritime compliance, energy analytics); 2M+ API requests/month
  • Badges: swapped badge.fury.io for shields.io npm/v; added node/v language badge; kept downloads, tests, license
  • Nav line: free API key (utm_source=node-sdk) · docs · pricing · jump link to the existing Quick Start anchor
  • New "What can you get?" 10-commodity table after Features (same commodities/columns as the PHP README)
  • New "The whole OilPriceAPI toolbox" cross-SDK table before Contributing (python, go, php, mcp, wordpress + preserved Sheets add-on link); removed the now-redundant "Also Available As" list
  • Version bump 1.0.1 in package.json and src/version.ts (the user-agent test suite asserts they match) + CHANGELOG entry

All other content (Beyond Oil, usage examples, streaming, API reference, error handling) preserved.

Verification

  • npm test: 429 passed, 1 skipped, 0 failed (the 3 version-consistency failures after the package.json bump were fixed by syncing src/version.ts)
  • Signup/pricing/docs URLs curl to 200; all cross-linked GitHub repos return 200

Do NOT merge without review.

🤖 Generated with Claude Code

Apply the shared registry-storefront formula from the PHP SDK:
- hero line (oil/gas/LNG/carbon/fuels in under 60 seconds) + audience line + 2M+ requests/month
- shields.io npm/v + node/v badges, nav line with utm_source=node-sdk and quick-start jump link
- "What can you get?" 10-commodity table after Features
- "The whole OilPriceAPI toolbox" cross-SDK table before Contributing
- bump version to 1.0.1 (package.json + src/version.ts, kept in sync for the user-agent tests) so npm re-renders the README

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 3, 2026

Copy link
Copy Markdown

Warning

Review limit reached

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

Next review available in: 49 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: 086c6c87-0b4f-4dc4-9b31-5a0a7d60d7dc

📥 Commits

Reviewing files that changed from the base of the PR and between 2915808 and 97a33e5.

📒 Files selected for processing (5)
  • CHANGELOG.md
  • README.md
  • package.json
  • src/version.ts
  • tests/live/futures.test.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/registry-storefront

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

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

karlwaldman and others added 2 commits July 3, 2026 10:08
…PI explorer

The newly-populated free-tier CI key gets a 403 object envelope on
plan-gated futures endpoints — a valid account state, not an SDK
regression. Tests now skip loudly (::warning::) instead of failing.
README links the interactive Swagger explorer + OpenAPI spec.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
First live run revealed the curve payload uses contracts[] (not curve)
and serializes settlement_price as strings (backend #3889). Test now
verifies against reality, tolerant of both shapes and price types.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@karlwaldman karlwaldman merged commit 203730e into main Jul 3, 2026
6 checks passed
@karlwaldman karlwaldman deleted the docs/registry-storefront branch July 3, 2026 14:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant