diff options
Diffstat (limited to 'libsyslog/README.md')
| -rw-r--r-- | libsyslog/README.md | 39 |
1 files changed, 25 insertions, 14 deletions
diff --git a/libsyslog/README.md b/libsyslog/README.md index 5b4f64b..360f56f 100644 --- a/libsyslog/README.md +++ b/libsyslog/README.md @@ -1,24 +1,24 @@ libsyslog ========= -The code (to be publiced shortly) in this crate provides an API implementing -the standard Rust logging facade using the system's syslog. That is, it -implements the [Log][] trait of the [log] crate for native syslog, typically -implemented in C and residing in libc. +The code in this crate provides an API implementing the standard Rust logging +facade using the system's syslog. That is, it implements the [Log][] trait of +the [log crate][] for native syslog, typically implemented in C and residing in +libc. Why? ---- How does this differ from the handful of other pre-existing syslog crates? This -one uses the system library implementation rather attempting to rewrite it in -Rust. The hope is thus to have a crate that works on pretty much any platform -with syslog, avoiding bugs from making assumptions on implementation specific -details. +one uses the system library implementation rather than attempting to rewrite it +in Rust. The hope is thus to have a crate that works on pretty much any +platform with syslog, avoiding bugs from making assumptions on implementation +specific details. The need arose from a desire to use syslog on illumos, a platform where most of the other syslog crates fail to even build and other(s) instead fail at runtime. -So far this code has only been attempted on illumos. Reports on success or -failures to use it on other platforms are most welcome. +A list of attempted platforms is maintained in [libsyslog-sys][api]. Reports on +success or failures to use it on other platforms are most welcome. Contact ------- @@ -26,10 +26,21 @@ Please see <https://www.netizen.se/#contact>. Copyright and License --------------------- -This crate is Copyright 2023 Martin Samuelsson. It is distributed under the -terms of both the MIT license and the Apache License (Version 2.0). +This crate is Copyright 2023 Martin Samuelsson. It is licensed under either of -See LICENSE-APACHE and LICENSE-MIT for details. + * Apache License, Version 2.0 + ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) + * MIT license + ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) +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. + +[api]: https://docs.rs/libsyslog-sys/latest/libsyslog_sys/ [Log]: https://docs.rs/log/latest/log/trait.Log.html -[log]: https://lib.rs/crates/log +[log crate]: https://lib.rs/crates/log |