Skip to content

Commit e47ec44

Browse files
committed
Readme updates
- Fix some broken links - Add a link to libcurl - Add some readme badges with relevant links
1 parent 55a27ae commit e47ec44

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ homepage = "https://github.com/alexcrichton/curl-rust"
88
documentation = "https://docs.rs/curl"
99
description = "Rust bindings to libcurl for making HTTP requests"
1010
categories = ["api-bindings", "web-programming::http-client"]
11+
readme = "README.md"
1112
autotests = true
1213

1314
[badges]

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# curl-rust
22

3-
libcurl bindings for Rust
3+
[libcurl] bindings for Rust
44

5-
[Documentation](https://docs.rs/curl)
5+
[![Latest Version](https://img.shields.io/crates/v/curl.svg)](https://crates.io/crates/curl)
6+
[![Documentation](https://docs.rs/curl/badge.svg)](https://docs.rs/curl)
7+
[![License](https://img.shields.io/github/license/alexcrichton/curl-rust.svg)](LICENSE)
8+
[![Build](https://github.com/alexcrichton/curl-rust/workflows/CI/badge.svg)](https://github.com/alexcrichton/curl-rust/actions)
69

710
## Quick Start
811

@@ -145,8 +148,7 @@ If you encounter the following error message:
145148
That means most likely, that curl was linked against `libcurl-nss.so` due to
146149
installed libcurl NSS development files, and that the required library
147150
`libnsspem.so` is missing. See also the curl man page: "If curl is built
148-
against the NSS SSL library, the NSS PEM PKCS#11 module (libnsspem.so) needs to
149-
be available for this option to work properly."
151+
against the NSS SSL library, the NSS PEM PKCS#11 module (`libnsspem.so`) needs to be available for this option to work properly."
150152

151153
In order to avoid this failure you can either
152154

@@ -156,10 +158,12 @@ In order to avoid this failure you can either
156158

157159
## License
158160

159-
The `curl-rust` crate is licensed under the MIT license, see `LICENSE` for more
161+
The `curl-rust` crate is licensed under the MIT license, see [`LICENSE`](LICENSE) for more
160162
details.
161163

162164

165+
[libcurl]: https://curl.haxx.se/libcurl/
166+
[MesaLink]: https://mesalink.io/
163167
[OpenSSL]: https://www.openssl.org/
164168
[Rustls]: https://github.com/ctz/rustls
165169
[Schannel]: https://docs.microsoft.com/en-us/windows/win32/com/schannel

0 commit comments

Comments
 (0)