Prep for release

collabora · Dec 19, 2024 · 858eee5 · 858eee5
1 parent 8e06f22
commit 858eee5
Show file tree

Hide file tree

Showing 11 changed files with 56 additions and 9 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -7,9 +7,13 @@ resolver = "2"
 
 [workspace.package]
 version = "0.1.0"
+authors = ["Ryan Gonzalez <[email protected]>"]
+categories = ["hardware-support", "os", "os::linux-apis"]
+keywords = ["linux", "sysfs", "usb"]
 edition = "2021"
 license = "MIT OR Apache-2.0"
-readme = "README.md"
+repository = "https://github.com/collabora/yuca"
+publish = true
 
 [workspace.dependencies]
 rustix = { version = "0.38.37", features = ["fs"] }

diff --git a/README.md b/README.md
@@ -1,5 +1,9 @@
 # yuca
 
+[![crates.io](https://img.shields.io/crates/v/yuca?style=for-the-badge)](https://crates.io/crates/yuca)
+[![docs.rs](https://img.shields.io/docsrs/yuca?style=for-the-badge)](https://docs.rs/yuca)
+[![build status](https://img.shields.io/github/actions/workflow/status/collabora/yuca/ci.yml?style=for-the-badge)](https://github.com/collabora/yuca/actions/workflows/ci.yml)
+
 Yuca is a Rust crate to access USB Type-C device information on Linux.
 
 ```rust,no_run

diff --git a/yuca-cli/Cargo.toml b/yuca-cli/Cargo.toml
@@ -1,6 +1,15 @@
 [package]
 name = "yuca-cli"
-edition = "2021"
+description = "Demo CLI for yuca (access USB Type-C device information on Linux)"
+readme = "README.md"
+version.workspace = true
+authors.workspace = true
+categories.workspace = true
+keywords.workspace = true
+edition.workspace = true
+license.workspace = true
+repository.workspace = true
+publish.workspace = true
 
 [[bin]]
 name = "yuca"
@@ -13,4 +22,4 @@ futures-lite = "2.5.0"
 owo-colors = { version = "4.1.0", features = ["supports-colors"] }
 tokio = { workspace = true, features = ["sync"] }
 usb-ids = "1.2024.5"
-yuca = { path = "../yuca" }
+yuca = { version = "0.1.0", path = "../yuca" }
diff --git a/yuca-cli/README.md b/yuca-cli/README.md
@@ -0,0 +1,14 @@
+# yuca-cli
+
+A demo CLI for [yuca](https://crates.io/crates/bilge).
+
+```
+Usage: yuca COMMAND ...
+
+Available options:
+    -h, --help  Prints help information
+
+Available commands:
+    tree        Print a tree of all available Type-C devices.
+    watch       Watch for added, removed, and changed devices.
+```
diff --git a/yuca/Cargo.toml b/yuca/Cargo.toml
@@ -1,6 +1,15 @@
 [package]
 name = "yuca"
-edition = "2021"
+description = "Access USB Type-C device information on Linux"
+readme = "README.md"
+version.workspace = true
+authors.workspace = true
+categories.workspace = true
+keywords.workspace = true
+edition.workspace = true
+license.workspace = true
+repository.workspace = true
+publish.workspace = true
 
 [features]
 default = ["tokio"]

diff --git a/yuca/README.md b/yuca/README.md
@@ -0,0 +1 @@
+../README.md
diff --git a/docs/overview.md → yuca/docs/overview.md b/docs/overview.md → yuca/docs/overview.md
@@ -182,6 +182,12 @@ println!("Port 0's power role is: {power_role:?}");
 # }
 ```
 
+Many of the properties directly correspond to the sysfs paths, so you can use
+the kernel's documentation on them as a point of reference:
+
+- https://www.kernel.org/doc/Documentation/ABI/testing/sysfs-class-typec
+- https://www.kernel.org/doc/Documentation/ABI/testing/sysfs-class-usb_power_delivery
+
 [`Device`]: trait@sysfs::Device
 [`Device::open`]: fn@sysfs::Device::open
 [`DeviceEntry`]: struct@sysfs::DeviceEntry

diff --git a/docs/watcher.md → yuca/docs/watcher.md b/docs/watcher.md → yuca/docs/watcher.md
diff --git a/yuca/src/lib.rs b/yuca/src/lib.rs
@@ -1,6 +1,6 @@
 #![cfg_attr(docsrs, feature(doc_cfg))]
-#![doc = include_str!("../../README.md")]
-#![doc = include_str!("../../docs/overview.md")]
+#![doc = include_str!("../README.md")]
+#![doc = include_str!("../docs/overview.md")]
 
 pub mod sysfs;
 pub mod types;

diff --git a/yuca/src/watcher.rs b/yuca/src/watcher.rs
@@ -1,4 +1,4 @@
-#![doc = include_str!("../../docs/watcher.md")]
+#![doc = include_str!("../docs/watcher.md")]
 
 use std::{
     collections::HashMap,