-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathREADME.tpl
39 lines (29 loc) · 1.27 KB
/
README.tpl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# {{crate}}
[![Test Status](https://github.com/deshaw/{{crate}}/workflows/Rust/badge.svg?event=push)](https://github.com/deshaw/{{crate}}/actions)
[![Crate](https://img.shields.io/crates/v/{{crate}}.svg)](https://crates.io/crates/{{crate}})
{{readme}}
## Usage
Add {{crate}} to your dependencies in `Cargo.toml`, enabling at least one of
the DNS resolver backends (see [Alternative Resolvers](README.md#alternative-resolvers-and-target-selection-policies)).
`libresolv` is enabled here as an example, but it is not required.
```toml
[dependencies]
{{crate}} = { version = "{{version}}", features = ["libresolv"] }
```
## Contributing
1. Clone the repo
2. Make some changes
3. Test: `cargo test --all-features`
4. Format: `cargo fmt`
5. Clippy: `cargo clippy --all-features --tests -- -Dclippy::all`
6. Bench: `cargo bench --all-features`
7. If modifying crate-level docs (`src/lib.rs`) or `README.tpl`, update `README.md`:
1. `cargo install cargo-readme`
2. `cargo readme > README.md`
## History
This project was contributed back to the community by the [D. E. Shaw group](https://www.deshaw.com/).
<p align="center">
<a href="https://www.deshaw.com">
<img src="https://www.deshaw.com/assets/logos/black_logo_417x125.png" alt="D. E. Shaw Logo" height="75" >
</a>
</p>