diff --git a/README.md b/README.md index 7915886..cfabcba 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Rust ClamAV Client -A simple ClamAV client to send files, in-memory data, and byte streams to `clamd` for antivirus scanning. Supports Tokio and async-std. +A simple ClamAV client to send files, in-memory data, and data streams to `clamd` for antivirus scanning. -Please note: The now deprecated functions `ping_socket`, `scan_file_socket`, `scan_buffer_socket`, `scan_stream_socket`, and `get_version_socket` are only available on Unix platforms. +It provides a synchronous API as well as asynchronous functions for both Tokio and async-std. Check out the [examples](#examples) below, the [integration tests](tests/clamav_client.rs), or the [API docs](https://docs.rs/clamav-client) for more information on how to use this library.