Add details to Cargo manifest

marcelbuesing · May 13, 2019 · 542876d · 542876d
1 parent 0ea84da
commit 542876d
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,8 +1,15 @@
 [package]
 name = "canutils"
 version = "0.1.0"
+license = "MIT"
+description = "A can-utils implementation in pure Rust"
 authors = ["marcelbuesing <buesing.marcel@googlemail.com>"]
 edition = "2018"
+homepage = "https://github.com/marcelbuesing/canutils-rs"
+repository = "https://github.com/marcelbuesing/canutils-rs.git"
+keywords = ["can-utils", "can", "automotive", "ecu"]
+documentation = "https://docs.rs/canutils"
+readme = "README.md"
 
 [dependencies]
 ansi_term = "0.11"

diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+# Binary Installation
+
+```
+cargo install --bins canutils
+``
+
+# Candumprb
+
+A colorful candump version.
+
+Run via:
+```
+candumprb vcan0
+``