summaryrefslogtreecommitdiffstats
path: root/third_party/rust/devd-rs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/rust/devd-rs/README.md')
-rw-r--r--third_party/rust/devd-rs/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/third_party/rust/devd-rs/README.md b/third_party/rust/devd-rs/README.md
new file mode 100644
index 0000000000..9313848029
--- /dev/null
+++ b/third_party/rust/devd-rs/README.md
@@ -0,0 +1,27 @@
+[![crates.io](https://img.shields.io/crates/v/devd-rs.svg)](https://crates.io/crates/devd-rs)
+[![unlicense](https://img.shields.io/badge/un-license-green.svg?style=flat)](https://unlicense.org)
+
+# devd-rs
+
+A Rust library for listening to FreeBSD (also DragonFlyBSD) [devd](https://www.freebsd.org/cgi/man.cgi?devd)'s device attach-detach notifications.
+
+Listens on `/var/run/devd.seqpacket.pipe` and parses messages using [nom](https://github.com/Geal/nom).
+
+## Usage
+
+See [examples/main.rs](https://github.com/unrelentingtech/devd-rs/blob/master/examples/main.rs).
+
+## Contributing
+
+Please feel free to submit pull requests!
+
+By participating in this project you agree to follow the [Contributor Code of Conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct/) and to release your contributions under the Unlicense and the MIT License.
+
+[The list of contributors is available on GitHub](https://github.com/unrelentingtech/devd-rs/graphs/contributors).
+
+## License
+
+This is free and unencumbered software released into the public domain.
+For more information, please refer to the `UNLICENSE` file or [unlicense.org](https://unlicense.org).
+
+It is also available under the MIT License.