Update README with branded header and documentation links
- Add centered logo and title with product branding - Add links to product website and documentation - Add badges for package manager and license - Add Other SDKs table with cross-references - Add Support section with dev@ironservices.io email - Update repository links to git.marketally.com 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
c4d90ba9ab
commit
80d87f92d6
49
README.md
49
README.md
|
|
@ -1,9 +1,30 @@
|
|||
# IronNotify SDK for JavaScript/TypeScript
|
||||
<p align="center">
|
||||
<a href="https://ironnotify.com">
|
||||
<img src="https://ironnotify.com/logo.png" alt="IronNotify" width="120" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
Event notifications and alerts SDK for JavaScript/TypeScript applications. Send notifications, receive real-time updates, and manage notification state.
|
||||
<h1 align="center">IronNotify SDK for JavaScript/TypeScript</h1>
|
||||
|
||||
[](https://www.npmjs.com/package/@ironservices/notify)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
<p align="center">
|
||||
<strong>Event notifications and alerts for modern applications</strong>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://www.npmjs.com/package/@ironservices/notify"><img src="https://img.shields.io/npm/v/@ironservices/notify.svg" alt="npm version"></a>
|
||||
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://ironnotify.com">Website</a> •
|
||||
<a href="https://ironnotify.com/docs">Documentation</a> •
|
||||
<a href="https://ironnotify.com/docs/js">JavaScript Guide</a> •
|
||||
<a href="https://git.marketally.com/ironservices">Git</a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
**IronNotify** helps you send event notifications and alerts to your users instantly. Built for developers who want simple, powerful notification infrastructure without the complexity.
|
||||
|
||||
## Installation
|
||||
|
||||
|
|
@ -321,6 +342,26 @@ function useNotifications(apiKey: string, userId: string) {
|
|||
- Fetch API (native in modern environments)
|
||||
- WebSocket API (for real-time features)
|
||||
|
||||
## Documentation
|
||||
|
||||
For complete documentation, visit [ironnotify.com/docs](https://ironnotify.com/docs).
|
||||
|
||||
## Other SDKs
|
||||
|
||||
| Platform | Package |
|
||||
|----------|---------|
|
||||
| .NET | [IronNotify.Client](https://git.marketally.com/ironservices/ironnotify-dotnet) |
|
||||
| Python | [ironnotify](https://git.marketally.com/ironservices/ironnotify-python) |
|
||||
| Go | [ironnotify-go](https://git.marketally.com/ironservices/ironnotify-go) |
|
||||
| Java | [ironnotify-java](https://git.marketally.com/ironservices/ironnotify-java) |
|
||||
| Rust | [ironnotify](https://git.marketally.com/ironservices/ironnotify-rust) |
|
||||
|
||||
## Support
|
||||
|
||||
- **Documentation**: [ironnotify.com/docs](https://ironnotify.com/docs)
|
||||
- **Email**: dev@ironservices.io
|
||||
- **Issues**: [git.marketally.com/ironservices/ironnotify-js/issues](https://git.marketally.com/ironservices/ironnotify-js/issues)
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see [LICENSE](LICENSE) for details.
|
||||
|
|
|
|||
Loading…
Reference in New Issue