Skip to content
This repository was archived by the owner on Feb 26, 2020. It is now read-only.

Commit 0730c27

Browse files
committed
Added docs and other minor improvements
1 parent 1467a14 commit 0730c27

File tree

4 files changed

+12
-8
lines changed

4 files changed

+12
-8
lines changed

Cargo.toml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
[package]
22
name = "hidapi"
3-
version = "0.3.0"
4-
authors = ["Roland Ruckerbauer <[email protected]>", "Osspial <[email protected]", "Artyom Pavlov <[email protected]>"]
3+
version = "0.3.1"
4+
authors = [
5+
"Roland Ruckerbauer <[email protected]>",
6+
"Osspial <[email protected]>",
7+
"Artyom Pavlov <[email protected]>"]
58
repository = "https://github.com/Osspial/hidapi-rs"
69
description = "Rust-y wrapper around hidapi"
710
license = "LGPL-3.0+"
8-
keywords = ["hid", "api", "binding"]
11+
keywords = ["hid", "api", "usb","binding", "wrapper"]
912
build = "build.rs"
1013
links = "hidapi"
14+
documentation = "https://beta.docs.rs/hidapi"
1115

1216
[dependencies]
1317
libc = "0.2.15"

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This crate provides a rust abstraction over the features of the C library
66

77
# Usage
88

9-
This crate is [on crates.io](https://crates.io/crates/hidapi) and can be
9+
This crate is on [crates.io](https://crates.io/crates/hidapi) and can be
1010
used by adding `hidapi` to the dependencies in your project's `Cargo.toml`.
1111

1212
```toml
@@ -40,4 +40,4 @@ println!("Wrote: {:?} byte(s)", res);
4040
```
4141

4242
# Documentation
43-
You can generate documentation by running `cargo doc` for this crate.
43+
Available at [on crates.io](https://beta.docs.rs/hidapi)

build.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ fn main() {
2828
fn compile() {
2929
let mut config = gcc::Config::new();
3030
config.file("etc/hidapi/libusb/hid.c").include("etc/hidapi/hidapi");
31-
let lib = pkg_config::find_library("libusb-1.0").unwrap();
31+
let lib = pkg_config::find_library("libusb-1.0").expect("Unable to find libusb-1.0");
3232
for path in lib.include_paths {
33-
config.include(path.to_str().unwrap());
33+
config.include(path.to_str().expect("Failed to convert include path to str"));
3434
}
3535
config.compile("libhidapi.a");
3636
}

src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
//! [dependencies]
3030
//! hidapi = "0.3"
3131
//! ```
32-
//! Example:
32+
//! # Example:
3333
//!
3434
//! ```rust,no_run
3535
//! extern crate hidapi;

0 commit comments

Comments
 (0)