Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing README documentation from recent commits #37

Merged
merged 1 commit into from
Oct 31, 2024
Merged

Add missing README documentation from recent commits #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Tappers

[![Cross-Platform]][CI Status] [![Latest Version]][crates.io] [![Documentation]][docs.rs] [![v1.66+]][Rust 1.66]
[![Cross-Platform]][CI Status] [![Latest Version]][crates.io] [![Documentation]][docs.rs] [![v1.70+]][Rust 1.70]

[Cross-Platform]: https://github.com/pkts-rs/tappers/actions/workflows/full_ci.yml/badge.svg
[CI Status]: https://github.com/pkts-rs/tappers/actions
[Documentation]: https://docs.rs/tappers/badge.svg
[docs.rs]: https://docs.rs/tappers/
[Latest Version]: https://img.shields.io/crates/v/tappers.svg
[crates.io]: https://crates.io/crates/tappers
[v1.66+]: https://img.shields.io/badge/MSRV-rustc_1.66+-blue.svg
[Rust 1.66]: https://blog.rust-lang.org/2022/12/15/Rust-1.66.0.html
[v1.70+]: https://img.shields.io/badge/MSRV-rustc_1.70+-blue.svg
[Rust 1.70]: https://blog.rust-lang.org/2023/06/01/Rust-1.70.0.html

---

Expand Down Expand Up @@ -234,14 +234,21 @@ runtimes:
## Dependency Policy

Like other crates managed by pkts.org, `tappers` aims to rely on a minimal set of dependencies
that are vetted and well-used in the Rust ecosystem. As such, `tappers` makes use of only the
following dependencies:
that are vetted and well-used in the Rust ecosystem. As such, `tappers` has only the following
dependencies:

* `libc`, `windows-sys` - Provides needed types and functions for creating/managing TUN/TAP
interfaces across various platforms.
* `once_cell` - Used in Windows implementation of `Tun`/`Tap`. Will be replaced with standard
* `once_cell` - Used in Windows implementation of `Tun`/`Tap`. Will be replaced with the standard
library once certain OnceCell APIs are stabilized.

The following optional dependencies are only included when various async runtime features are enabled:
* `async-std` - Included for async compatibility with the `async-std` runtime
* `mio` - Included for async compatibility with the `mio` runtime
* `smol` - Included for async compatibility with the `smol` runtime
* `tokio` - Included for async compatibility with the `tokio` runtime
* `async-io` - Additional dependency for the `async-std` and `smol` runtimes

We do not plan on adding in any additional dependencies to `tappers`. The one exception to this
rule is that some common structs (e.g. `MacAddr`, `Interface`) may be split out into a separate
crate in a future release.
Expand Down