Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
pfmooney committed May 1, 2020
1 parent 73a008e commit 32d27e9
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,31 @@
# mio-uds

[![Build Status](https://travis-ci.org/alexcrichton/mio-uds.svg?branch=master)](https://travis-ci.org/alexcrichton/mio-uds)

[Documentation](https://docs.rs/mio-uds)

A library for integrating Unix Domain Sockets with [mio]. Based on the standard
library's [support for Unix sockets][std], except all of the abstractions and
types are nonblocking to conform with the expectations of mio.

[mio]: https://github.com/carllerche/mio
[mio]: https://github.com/tokio-rs/mio
[std]: https://doc.rust-lang.org/std/os/unix/net/

[![Build Status](https://github.com/deprecrated/mio-uds/workflows/CI/badge.svg)](https://github.com/deprecrated/mio-uds/actions?query=workflow%3ACI+branch%3Amaster)
[![Documentation](https://docs.rs/mio-uds/badge.svg?version=0.6)](https://docs.rs/mio-uds/~0.6)

# mio-uds is Deprecated

With the 0.7 release, `mio` now includes native support for Unix Domain
Sockets. Consumers should switch to that functionality when updating their
`mio` dependency to the 0.7.x series.


## Usage

```toml
# Cargo.toml
[dependencies]
mio-uds = "0.6"
mio = "0.6"
```

## Usage

The three exported types at the top level, `UnixStream`, `UnixListener`, and
`UnixDatagram`, are thin wrappers around the libstd counterparts. They can be
used in similar fashions to mio's TCP and UDP types in terms of registration and
Expand All @@ -38,4 +44,6 @@ at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.

0 comments on commit 32d27e9

Please sign in to comment.