Skip to content

Commit a8a2868

Browse files
grokifyclaude
andcommitted
docs: prepare v0.5.0 release documentation
- Add v0.5.0 entry to CHANGELOG.json with IRC provider - Regenerate CHANGELOG.md via schangelog - Update README.md with IRC provider in features table - Add docs/providers/irc.md provider documentation - Add docs/releases/v0.5.0.md release notes - Update docs/providers/index.md with IRC - Update mkdocs.yml navigation with IRC provider and v0.5.0 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent ebc0111 commit a8a2868

File tree

8 files changed

+440
-13
lines changed

8 files changed

+440
-13
lines changed

CHANGELOG.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,22 @@
77
"commitConvention": "conventional",
88
"maintainers": ["grokify", "johncwang@gmail.com"],
99
"releases": [
10+
{
11+
"version": "v0.5.0",
12+
"date": "2026-03-28",
13+
"highlights": [
14+
{ "description": "IRC provider for channel and direct message support" }
15+
],
16+
"added": [
17+
{ "description": "IRC provider using ergochat/irc-go v0.6.0 with TLS, NickServ auth, and multi-channel support", "commit": "ebc0111" }
18+
],
19+
"dependencies": [
20+
{ "description": "Add github.com/ergochat/irc-go v0.6.0", "commit": "ebc0111" },
21+
{ "description": "Bump go.mau.fi/whatsmeow to latest", "commit": "ebc0111" },
22+
{ "description": "Bump cloud.google.com/go/auth to v0.19.0", "commit": "ebc0111" },
23+
{ "description": "Bump google.golang.org/api to v0.273.0", "commit": "ebc0111" }
24+
]
25+
},
1026
{
1127
"version": "v0.4.0",
1228
"date": "2026-03-22",

CHANGELOG.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,23 @@ and this changelog is generated by [Structured Changelog](https://github.com/gro
99

1010
## [Unreleased]
1111

12+
## [v0.5.0] - 2026-03-28
13+
14+
### Highlights
15+
16+
- IRC provider for channel and direct message support
17+
18+
### Added
19+
20+
- IRC provider using ergochat/irc-go v0.6.0 with TLS, NickServ auth, and multi-channel support ([`ebc0111`](https://github.com/plexusone/omnichat/commit/ebc0111))
21+
22+
### Dependencies
23+
24+
- Add github.com/ergochat/irc-go v0.6.0 ([`ebc0111`](https://github.com/plexusone/omnichat/commit/ebc0111))
25+
- Bump go.mau.fi/whatsmeow to latest ([`ebc0111`](https://github.com/plexusone/omnichat/commit/ebc0111))
26+
- Bump cloud.google.com/go/auth to v0.19.0 ([`ebc0111`](https://github.com/plexusone/omnichat/commit/ebc0111))
27+
- Bump google.golang.org/api to v0.273.0 ([`ebc0111`](https://github.com/plexusone/omnichat/commit/ebc0111))
28+
1229
## [v0.4.0] - 2026-03-22
1330

1431
### Highlights
@@ -102,7 +119,8 @@ and this changelog is generated by [Structured Changelog](https://github.com/gro
102119
- CodeQL security analysis workflow ([`c454b30`](https://github.com/plexusone/omnichat/commit/c454b30))
103120
- Dependabot configuration for Go modules ([`c454b30`](https://github.com/plexusone/omnichat/commit/c454b30))
104121

105-
[unreleased]: https://github.com/plexusone/omnichat/compare/v0.4.0...HEAD
122+
[unreleased]: https://github.com/plexusone/omnichat/compare/v0.5.0...HEAD
123+
[v0.5.0]: https://github.com/plexusone/omnichat/compare/v0.4.0...v0.5.0
106124
[v0.4.0]: https://github.com/plexusone/omnichat/compare/v0.3.0...v0.4.0
107125
[v0.3.0]: https://github.com/plexusone/omnichat/compare/v0.2.0...v0.3.0
108126
[v0.2.0]: https://github.com/plexusone/omnichat/compare/v0.1.0...v0.2.0

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# OmniChat
22

3-
# OmniSerp Multi-Search Client and MCP Server
4-
53
[![Go CI][go-ci-svg]][go-ci-url]
64
[![Go Lint][go-lint-svg]][go-lint-url]
75
[![Go SAST][go-sast-svg]][go-sast-url]
@@ -46,6 +44,7 @@ A Go library providing a unified interface for messaging platforms.
4644
| WhatsApp | `providers/whatsapp` | QR auth, voice notes, media |
4745
| Slack | `providers/slack` | Socket Mode, channels, threads |
4846
| Gmail | `providers/email/gmail` | OAuth2, HTML/Markdown email |
47+
| IRC | `providers/irc` | TLS, NickServ auth, multi-channel |
4948

5049
## Installation
5150

@@ -144,6 +143,21 @@ p, err := whatsapp.New(whatsapp.Config{
144143
})
145144
```
146145

146+
### IRC
147+
148+
```go
149+
import "github.com/plexusone/omnichat/providers/irc"
150+
151+
p, err := irc.New(irc.Config{
152+
Server: "irc.libera.chat:6697",
153+
Nick: "mybot",
154+
Password: os.Getenv("IRC_PASSWORD"), // NickServ password
155+
Channels: []string{"#mychannel"},
156+
UseTLS: true,
157+
Logger: slog.Default(),
158+
})
159+
```
160+
147161
## Router
148162

149163
The router manages multiple providers and routes messages:

docs/changelog.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,23 @@ and this changelog is generated by [Structured Changelog](https://github.com/gro
99

1010
## [Unreleased]
1111

12+
## [v0.5.0] - 2026-03-28
13+
14+
### Highlights
15+
16+
- IRC provider for channel and direct message support
17+
18+
### Added
19+
20+
- IRC provider using ergochat/irc-go v0.6.0 with TLS, NickServ auth, and multi-channel support ([`ebc0111`](https://github.com/plexusone/omnichat/commit/ebc0111))
21+
22+
### Dependencies
23+
24+
- Add github.com/ergochat/irc-go v0.6.0 ([`ebc0111`](https://github.com/plexusone/omnichat/commit/ebc0111))
25+
- Bump go.mau.fi/whatsmeow to latest ([`ebc0111`](https://github.com/plexusone/omnichat/commit/ebc0111))
26+
- Bump cloud.google.com/go/auth to v0.19.0 ([`ebc0111`](https://github.com/plexusone/omnichat/commit/ebc0111))
27+
- Bump google.golang.org/api to v0.273.0 ([`ebc0111`](https://github.com/plexusone/omnichat/commit/ebc0111))
28+
1229
## [v0.4.0] - 2026-03-22
1330

1431
### Highlights
@@ -102,7 +119,8 @@ and this changelog is generated by [Structured Changelog](https://github.com/gro
102119
- CodeQL security analysis workflow ([`c454b30`](https://github.com/plexusone/omnichat/commit/c454b30))
103120
- Dependabot configuration for Go modules ([`c454b30`](https://github.com/plexusone/omnichat/commit/c454b30))
104121

105-
[unreleased]: https://github.com/plexusone/omnichat/compare/v0.4.0...HEAD
122+
[unreleased]: https://github.com/plexusone/omnichat/compare/v0.5.0...HEAD
123+
[v0.5.0]: https://github.com/plexusone/omnichat/compare/v0.4.0...v0.5.0
106124
[v0.4.0]: https://github.com/plexusone/omnichat/compare/v0.3.0...v0.4.0
107125
[v0.3.0]: https://github.com/plexusone/omnichat/compare/v0.2.0...v0.3.0
108126
[v0.2.0]: https://github.com/plexusone/omnichat/compare/v0.1.0...v0.2.0

docs/providers/index.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ OmniChat supports multiple messaging platforms through a unified provider interf
1111
| [WhatsApp](whatsapp.md) | `providers/whatsapp` | Chat | QR code |
1212
| [Slack](slack.md) | `providers/slack` | Chat | OAuth tokens |
1313
| [Gmail](gmail.md) | `providers/email/gmail` | Email | OAuth2 |
14+
| [IRC](irc.md) | `providers/irc` | Chat | NickServ (optional) |
1415

1516
## Provider Interface
1617

@@ -104,15 +105,15 @@ router.ConnectAll(ctx)
104105

105106
Each provider may support additional features:
106107

107-
| Feature | Discord | Telegram | WhatsApp | Slack | Gmail |
108-
|---------|---------|----------|----------|-------|-------|
109-
| Text messages | Yes | Yes | Yes | Yes | Yes |
110-
| Media attachments | Yes | Yes | Yes | Yes | Yes |
111-
| Voice messages | No | Yes | Yes | No | No |
112-
| Reactions | Yes | Yes | Yes | Yes | No |
113-
| Threads | Yes | Yes | Yes | Yes | Yes |
114-
| Typing indicators | Yes | Yes | Yes | No | No |
115-
| Read receipts | No | Yes | Yes | No | No |
108+
| Feature | Discord | Telegram | WhatsApp | Slack | Gmail | IRC |
109+
|---------|---------|----------|----------|-------|-------|-----|
110+
| Text messages | Yes | Yes | Yes | Yes | Yes | Yes |
111+
| Media attachments | Yes | Yes | Yes | Yes | Yes | No |
112+
| Voice messages | No | Yes | Yes | No | No | No |
113+
| Reactions | Yes | Yes | Yes | Yes | No | No |
114+
| Threads | Yes | Yes | Yes | Yes | Yes | No |
115+
| Typing indicators | Yes | Yes | Yes | No | No | No |
116+
| Read receipts | No | Yes | Yes | No | No | No |
116117

117118
## Error Handling
118119

@@ -137,3 +138,4 @@ if err != nil {
137138
- [WhatsApp](whatsapp.md) - WhatsApp Web setup
138139
- [Slack](slack.md) - Slack app setup
139140
- [Gmail](gmail.md) - Gmail API setup
141+
- [IRC](irc.md) - IRC server connection

0 commit comments

Comments
 (0)