diff README.md @ 6:a7893294e9b2

Make the crate compilable on non-linux systems This makes the crate compile on other operating systems. Since systemd is only supported on Linux, it simply disables systemd features on other systems. The API is still the same, just parsing `systemd://` string will return an error.
author Martin Habovstiak <martin.habovstiak@gmail.com>
date Fri, 27 Nov 2020 16:15:57 +0100
parents 66c0e10c89fc
children f740dadd2948
line wrap: on
line diff
--- a/README.md	Fri Nov 27 15:18:25 2020 +0100
+++ b/README.md	Fri Nov 27 16:15:57 2020 +0100
@@ -13,6 +13,9 @@
 Thanks to this the change to your code should be minimal - parsing will continue to work, it'll just allow a new format.
 You only need to change the code to use `SocketAddr::bind()` instead of `TcpListener::bind()` for binding.
 
+You also don't need to worry about conditional compilation to ensure OS compatibility.
+This crate handles that for you by disabling systemd on non-linux systems.
+
 Further, the crate also provides methods for binding `tokio` 0.2, 0.3, and `async_std` sockets if the appropriate features are
 activated.