Skip to content

Commit 90eb84f

Browse files
karlwaldmanclaude
andcommitted
docs: Add pricing CTA, badges, and Why OilPriceAPI section to README
Match Python SDK README quality with Bloomberg comparison messaging, npm downloads badge, test status badge, and docs.oilpriceapi.com links. Closes #1604 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent fff0ace commit 90eb84f

1 file changed

Lines changed: 31 additions & 8 deletions

File tree

README.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
# Oil Price API - Node.js SDK
22

3+
> **Real-time oil and commodity price data for Node.js** - Professional-grade API at 98% less cost than Bloomberg Terminal
4+
35
[![npm version](https://badge.fury.io/js/oilpriceapi.svg)](https://www.npmjs.com/package/oilpriceapi)
6+
[![npm downloads](https://img.shields.io/npm/dm/oilpriceapi)](https://www.npmjs.com/package/oilpriceapi)
7+
[![Tests](https://github.com/OilpriceAPI/oilpriceapi-node/actions/workflows/test.yml/badge.svg)](https://github.com/OilpriceAPI/oilpriceapi-node/actions/workflows/test.yml)
48
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
59

6-
Official Node.js SDK for [Oil Price API](https://www.oilpriceapi.com) - Get real-time and historical oil & commodity prices.
10+
**[Get Free API Key](https://www.oilpriceapi.com/signup)** | **[Documentation](https://docs.oilpriceapi.com)** | **[Pricing](https://www.oilpriceapi.com/pricing)**
11+
12+
The official Node.js/TypeScript SDK for [OilPriceAPI](https://www.oilpriceapi.com) - Real-time and historical oil prices for Brent Crude, WTI, Natural Gas, and 100+ commodities.
713

814
## Features
915

@@ -950,22 +956,39 @@ We welcome contributions! Please see our [Contributing Guide](https://github.com
950956

951957
## Support
952958

953-
- 📧 Email: support@oilpriceapi.com
954-
- 🐛 Issues: [GitHub Issues](https://github.com/OilpriceAPI/oilpriceapi-node/issues)
955-
- 📚 Documentation: [oilpriceapi.com/docs](https://www.oilpriceapi.com/docs)
956-
- 💬 Discord: [Join our community](https://discord.gg/oilpriceapi)
959+
- Email: support@oilpriceapi.com
960+
- Issues: [GitHub Issues](https://github.com/OilpriceAPI/oilpriceapi-node/issues)
961+
- Docs: [Documentation](https://docs.oilpriceapi.com)
957962

958963
## License
959964

960965
MIT License - see [LICENSE](LICENSE) file for details.
961966

962967
## Links
963968

964-
- [Website](https://www.oilpriceapi.com)
965-
- [API Documentation](https://www.oilpriceapi.com/docs)
969+
- [OilPriceAPI Website](https://www.oilpriceapi.com)
970+
- [API Documentation](https://docs.oilpriceapi.com)
971+
- [Pricing](https://www.oilpriceapi.com/pricing)
972+
- [Status Page](https://status.oilpriceapi.com)
966973
- [GitHub Repository](https://github.com/OilpriceAPI/oilpriceapi-node)
967974
- [npm Package](https://www.npmjs.com/package/oilpriceapi)
968975

969976
---
970977

971-
Made with ❤️ by the Oil Price API team
978+
## Why OilPriceAPI?
979+
980+
[OilPriceAPI](https://www.oilpriceapi.com) provides professional-grade commodity price data at **98% less cost than Bloomberg Terminal** ($24,000/year vs $45/month). Trusted by energy traders, financial analysts, and developers worldwide.
981+
982+
### Key Benefits
983+
984+
- **Real-time data** updated every 5 minutes
985+
- **Historical data** for trend analysis and backtesting
986+
- **99.9% uptime** with enterprise-grade reliability
987+
- **5-minute integration** with this Node.js SDK
988+
- **Free tier** with 100 requests to get started
989+
990+
**[Start Free](https://www.oilpriceapi.com/signup)** | **[View Pricing](https://www.oilpriceapi.com/pricing)** | **[Read Docs](https://docs.oilpriceapi.com)**
991+
992+
---
993+
994+
Made with care by the OilPriceAPI Team

0 commit comments

Comments
 (0)