add readme to Cargo.toml

seanmonstar · Sep 28, 2017 · b991064 · b991064
1 parent 41fdbfc
commit b991064
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/Cargo.toml b/Cargo.toml
@@ -9,6 +9,7 @@ repository = "https://github.com/seanmonstar/num_cpus"
 documentation = "https://docs.rs/num_cpus"
 keywords = ["cpu", "cpus", "cores"]
 categories = ["hardware-support"]
+readme = "README.md"
 
 [dependencies]
 libc = "0.2.26"
diff --git a/README.md b/README.md
@@ -23,6 +23,6 @@ In your `main.rs` or `lib.rs`:
 ```rust
 extern crate num_cpus;
 
-// elsewhere
+// count logical cores this process could try to use
 let num = num_cpus::get();
 ```