Skip to content
This repository was archived by the owner on Jul 4, 2024. It is now read-only.

Commit 7b935a7

Browse files
committed
Fix README for client-only pkg
... adjust the README, fix the badge.
1 parent 9aa530c commit 7b935a7

File tree

1 file changed

+7
-29
lines changed

1 file changed

+7
-29
lines changed

README.md

Lines changed: 7 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
1-
# SwiftNIO IRC
1+
# SwiftNIO IRC Client
22

33
![Swift4](https://img.shields.io/badge/swift-4-blue.svg)
44
![iOS](https://img.shields.io/badge/os-iOS-green.svg?style=flat)
55
![macOS](https://img.shields.io/badge/os-macOS-green.svg?style=flat)
66
![tuxOS](https://img.shields.io/badge/os-tuxOS-green.svg?style=flat)
7-
![Travis](https://travis-ci.org/NozeIO/swift-nio-irc.svg?branch=develop)
7+
![Travis](https://travis-ci.org/NozeIO/swift-nio-irc-client.svg?branch=develop)
88

99
SwiftNIO-IRC is a Internet Relay Chat
1010
[protocol implementation](Sources/NIOIRC) for
1111
[SwiftNIO](https://github.com/apple/swift-nio)
1212
and a simple
1313
[IRC client](Sources/IRC).
1414

15-
This module contains the protocol implementation and the client, we also
15+
This module contains a simple IRC client library. We also
1616
provide:
17+
- [swift-nio-irc](https://github.com/SwiftNIOExtras/swift-nio-irc) -
18+
the raw Swift NIO IRC protocol implementation
1719
- [swift-nio-irc-webclient](https://github.com/NozeIO/swift-nio-irc-webclient) -
1820
a simple IRC webclient + WebSocket gateway based on this module,
1921
- [swift-nio-irc-eliza](https://github.com/NozeIO/swift-nio-irc-eliza) -
@@ -42,41 +44,17 @@ import PackageDescription
4244
let package = Package(
4345
name: "IRCTests",
4446
dependencies: [
45-
.package(url: "https://github.com/NozeIO/swift-nio-irc.git",
46-
from: "0.5.0")
47+
.package(url: "https://github.com/NozeIO/swift-nio-irc-client.git",
48+
from: "0.6.0")
4749
],
4850
targets: [
49-
.target(name: "MyProtocolTool",
50-
dependencies: [ "NIOIRC" ]),
5151
.target(name: "MyIRCClient",
5252
dependencies: [ "IRC" ])
5353
]
5454
)
5555
```
5656

5757

58-
## Using the SwiftNIO IRC protocol handler
59-
60-
The IRC protocol is implemented as a regular
61-
`ChannelHandler`, similar to `NIOHTTP1`.
62-
It takes incoming `ByteBuffer` data, parses that, and emits `IRCMessage`
63-
items.
64-
Same the other way around, the user writes `IRCReply`
65-
objects, and the handler renders such into `ByteBuffer`s.
66-
67-
To add the IRC handler to a NIO Channel pipeline:
68-
69-
```swift
70-
import NIOIRC
71-
72-
bootstrap.channelInitializer { channel in
73-
channel.pipeline
74-
.add(handler: IRCChannelHandler())
75-
.then { ... }
76-
}
77-
```
78-
79-
8058
### Who
8159

8260
Brought to you by

0 commit comments

Comments
 (0)