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
905413e75a
commit
7eca347e1f
59
README.md
59
README.md
|
|
@ -1,14 +1,35 @@
|
|||
# IronNotify SDK for Go
|
||||
<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 Go applications. Send notifications, receive real-time updates, and manage notification state.
|
||||
<h1 align="center">IronNotify SDK for Go</h1>
|
||||
|
||||
[](https://pkg.go.dev/github.com/IronServices/ironnotify-go)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
<p align="center">
|
||||
<strong>Event notifications and alerts for Go applications</strong>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://pkg.go.dev/git.marketally.com/ironservices/ironnotify-go"><img src="https://pkg.go.dev/badge/git.marketally.com/ironservices/ironnotify-go.svg" alt="Go Reference"></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/go">Go 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
|
||||
|
||||
```bash
|
||||
go get github.com/IronServices/ironnotify-go
|
||||
go get git.marketally.com/ironservices/ironnotify-go
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
|
@ -20,7 +41,7 @@ package main
|
|||
|
||||
import (
|
||||
"fmt"
|
||||
ironnotify "github.com/IronServices/ironnotify-go"
|
||||
ironnotify "git.marketally.com/ironservices/ironnotify-go"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
|
@ -56,7 +77,7 @@ package main
|
|||
|
||||
import (
|
||||
"time"
|
||||
ironnotify "github.com/IronServices/ironnotify-go"
|
||||
ironnotify "git.marketally.com/ironservices/ironnotify-go"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
|
@ -89,7 +110,7 @@ func main() {
|
|||
package main
|
||||
|
||||
import (
|
||||
ironnotify "github.com/IronServices/ironnotify-go"
|
||||
ironnotify "git.marketally.com/ironservices/ironnotify-go"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
|
@ -118,7 +139,7 @@ func main() {
|
|||
## Configuration
|
||||
|
||||
```go
|
||||
import ironnotify "github.com/IronServices/ironnotify-go"
|
||||
import ironnotify "git.marketally.com/ironservices/ironnotify-go"
|
||||
|
||||
client, _ := ironnotify.NewClient(ironnotify.Options{
|
||||
APIKey: "ak_live_xxxxx",
|
||||
|
|
@ -281,6 +302,26 @@ client.FlushContext(ctx)
|
|||
|
||||
The client is thread-safe and can be used from multiple goroutines concurrently.
|
||||
|
||||
## Documentation
|
||||
|
||||
For complete documentation, visit [ironnotify.com/docs](https://ironnotify.com/docs).
|
||||
|
||||
## Other SDKs
|
||||
|
||||
| Platform | Package |
|
||||
|----------|---------|
|
||||
| JavaScript/TypeScript | [@ironservices/notify](https://git.marketally.com/ironservices/ironnotify-js) |
|
||||
| .NET | [IronNotify.Client](https://git.marketally.com/ironservices/ironnotify-dotnet) |
|
||||
| Python | [ironnotify](https://git.marketally.com/ironservices/ironnotify-python) |
|
||||
| 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-go/issues](https://git.marketally.com/ironservices/ironnotify-go/issues)
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see [LICENSE](LICENSE) for details.
|
||||
|
|
|
|||
Loading…
Reference in New Issue