example code for main imports

Cargo.toml

@@ -5,7 +5,7 @@ description = "List system USB buses and devices; a modern and compatible `lsusb
 repository = "https://github.com/tuna-f1sh/cyme"
 readme = "README.md"
 license = "GPL-3.0-or-later"
-version = "1.2.1"
+version = "1.2.2"
 edition = "2021"
 keywords = ["usb", "lsusb", "system_profiler", "macos", "libusb"]
 categories = ["command-line-utilities"]

README.md

@@ -78,7 +78,7 @@ Will cover this more as it develops. Use `cyme --help` for basic usage or `man .
 
 ## Crate
 
-For usage as a library for profiling system USB devices, the crate is 100% documented so look at [docs.rs](https://docs.rs/cyme/latest/cyme/)
+For usage as a library for profiling system USB devices, the crate is 100% documented so look at [docs.rs](https://docs.rs/cyme/latest/cyme/). The main useful modules for import are [system_profiler](https://docs.rs/cyme/latest/cyme/system_profiler/index.html), [lsusb::profiler](https://docs.rs/cyme/latest/cyme/lsusb/profiler/index.html) and [usb](https://docs.rs/cyme/latest/cyme/usb/index.html)
 
 ## Config
 

src/lsusb.rs

@@ -6,6 +6,17 @@ pub mod profiler {
     //! Uses rusb (upto date libusb fork) to get system USB information, most of which has parity with lsusb. Requires 'libusb' feature. Uses [`crate::system_profiler`] types to hold data so that it is cross-compatible with macOS system_profiler command.
     //!
     //! lsusb uses udev for tree building, which libusb does not have access to and is Linux only. udev-rs is used on Linux to attempt to mirror the output of lsusb on Linux. On other platforms, certain information like driver used cannot be obtained.
+    //!
+    //! Get [`system_profiler::SPUSBDataType`] struct of system USB buses and devices with extra data like configs, interfaces and endpoints
+    //! ```no_run
+    //! use cyme::lsusb::profiler;
+    //!
+    //! let spusb = profiler::get_spusb_with_extra().unwrap();
+    //! // print with alternative styling (#) is using utf-8 icons
+    //! println!("{:#}", spusb);
+    //! ```
+    //!
+    //! See [`system_profiler`] docs for what can be done with returned data, such as [`system_profiler::USBFilter`]
     use std::collections::HashMap;
     use std::time::Duration;
     use itertools::Itertools;

src/system_profiler.rs

@@ -1,6 +1,22 @@
 //! Parser for macOS `system_profiler` command -json output with SPUSBDataType.
 //!
 //! USBBus and USBDevice structs are used as deserializers for serde. The JSON output with the -json flag is not really JSON; all values are String regardless of contained data so it requires some extra work. Additionally, some values differ slightly from the non json output such as the speed - it is a description rather than numerical.
+//!
+//! Get [`SPUSBDataType`] from macOS system_profiler and print
+//! ```no_run
+//! use cyme::system_profiler;
+//!
+//! let spusb = system_profiler::get_spusb().unwrap();
+//! // print with alternative styling (#) is using utf-8 icons
+//! println!("{:#}", spusb);
+//! ```
+//!
+//! Get [`SPUSBDataType`] from macOS system_profiler and merge with extra data from libusb
+//! ```no_run
+//! use cyme::system_profiler;
+//!
+//! let spusb = system_profiler::get_spusb_with_extra().unwrap();
+//! ```
 use std::fmt;
 use std::io;
 use std::fs;