Skip to content

Commit 5d7af4c

Browse files
committed
update readme
1 parent 8cdb82c commit 5d7af4c

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RabbitMQNIO
22
[<img src="https://img.shields.io/badge/platform-macOS | Linux-brightgreen.svg" alt="Platform macOS | Linux" />](https://swift.org)
3-
[<img src="https://img.shields.io/badge/swift-5.7-brightgreen.svg" alt="Swift 5.7" />](https://swift.org)
3+
[<img src="https://img.shields.io/badge/swift-5.10-brightgreen.svg" alt="Swift 5.10" />](https://swift.org)
44

55

66
A Swift implementation of AMQP 0.9.1 protocol: decoder + encoder (AMQPProtocol) and non-blocking client (AMQPClient).
@@ -13,21 +13,19 @@ Swift-NIO related code is based on other NIO projects like:
1313
* https://gitlab.com/swift-server-community/RediStack
1414

1515
## State of the project
16-
17-
**!!! WARNING !!!** <br>
18-
This project is in alpha stage and still under development - API can change in the near future before 1.0 release. <br>
19-
Please do extensive tests of Your use case before using it on production! <br>
20-
Nevertheless, current client operations are tested and appears to be stable so do not be afraid to use it. <br>
21-
Please report bugs or missing features. <br>
22-
**!!! WARNING !!!**
23-
24-
AMQPProtocol library currently should cover all of AMQP 0.9.1 specification.
25-
26-
AMQPClient library's architecture using NIO Channels is already done and all of AMQP operations (without WebSockets) should be supported.
27-
Current work is focused on testing, finding bugs, API stabilization and code refactoring / polishing (based on Swift Server Side Community feedback).
16+
This project is in beta stage - API still can change before the first stable release.<br>
17+
It's been used in production for more than a year now.<br>
18+
19+
AMQPProtocol library covers all of AMQP 0.9.1 specification.
20+
AMQPClient library's architecture using NIO Channels is already done, and all of the common AMQP operations are working (without WebSockets support).<br>
21+
The main goal of the project is now to release the first stable version. To do this project needs:
22+
* API stabilization.
23+
* Closing the issues (most of them are quality improvements to the project),
24+
* Refactoring swift-nio code with the newest async stuff.
25+
* Writing proper documentation.
26+
* Polishing based on Swift Server Side Community feedback (please use it and report bugs and suggestions!).
2827

2928
## Basic usage
30-
3129
Create a connection and connect to the AMQP broker using connection string.
3230
```swift
3331
let eventLoopGroup = MultiThreadedEventLoopGroup(numberOfThreads: 1)
@@ -149,7 +147,6 @@ do {
149147
```
150148

151149
## Connection recovery patterns.
152-
153150
Handling broker closing channel or connection disconnects.
154151
Connection to AMQP broker is sustained by answering to heartbeat messages, however on network problem or broker restart connection can be broken.
155152
Broker can also close channel or connection on bad command or other error.

0 commit comments

Comments
 (0)