File tree Expand file tree Collapse file tree 3 files changed +24
-1
lines changed Expand file tree Collapse file tree 3 files changed +24
-1
lines changed Original file line number Diff line number Diff line change @@ -13,6 +13,7 @@ repository = "https://github.com/erickt/rust-zmq"
1313readme = " README.md"
1414build = " build.rs"
1515edition = " 2018"
16+ maintainance = { status = " passively-maintained" }
1617
1718[features ]
1819default = [" zmq_has" ]
Original file line number Diff line number Diff line change 4343
4444- New functions ` proxy_steerable ` and ` proxy_steerable_with_capture ` ,
4545 which wrap the ` zmq_proxy_steerable ` C function. Implemented in
46- #242 ,
46+ #242 .
4747
4848[ `README` ] : ./README.md
4949[ `zeromq-src` ] : https://github.com/jean-airoldie/zeromq-src-rs
Original file line number Diff line number Diff line change @@ -12,6 +12,28 @@ Rust ZeroMQ bindings.
1212
1313[ Release Notes] ( https://github.com/erickt/rust-zmq/tree/master/NEWS.md )
1414
15+ # About
16+
17+ The ` zmq ` crate provides bindings for the ` libzmq ` library from the
18+ [ ZeroMQ] ( https://zeromq.org/ ) project. The API exposed by ` zmq ` should
19+ be safe (in the usual Rust sense), but it follows the C API closely,
20+ so it is not very idiomatic. Also, support for ` libzmq ` API in "draft"
21+ state is considered out-of-scope for this crate; this includes
22+ currently, as of libzmq 4.3.3:
23+
24+ - Newer, thread-safe socket types, such as ` ZMQ_CLIENT ` and
25+ ` ZMQ_SERVER ` .
26+ - The "poller" API.
27+
28+ For a more modern, idiomatic approach to ` libzmq ` bindings, including
29+ draft API features, have a look at
30+ [ ` libzmq-rs ` ] ( https://github.com/jean-airoldie/libzmq-rs ) .
31+
32+ # Compatibility
33+
34+ The current 0.9 release series requires ` libzmq ` 4.1 or newer. New
35+ release series of ` zmq ` may require newer ` libzmq ` versions.
36+
1537# Installation
1638
1739rust-zmq is available from [ crates.io] ( https://crates.io ) . Users
You can’t perform that action at this time.
0 commit comments