Update README.md, and test it going forward.

Author: matanlurey

.github/workflows/rust.yml

@@ -55,7 +55,9 @@ jobs:
         tool: cargo-llvm-cov, nextest
 
     - name: Test
-      run: cargo llvm-cov nextest --no-fail-fast --lcov --output-path lcov.info
+      run: |
+        cargo test --doc
+        cargo llvm-cov nextest --no-fail-fast --lcov --output-path lcov.info
 
     - name: Upload Coverage
       if: matrix.os == 'ubuntu-latest'

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.0+1] - 2025-06-01
+
+### Changed
+
+- Updated examples in `README.md` to reflect the new API.
+
 ## [0.2.0] - 2025-06-01
 
 ### Added

Cargo.lock

@@ -3,7 +3,7 @@ name = "proc-result"
 description = "A tiny cross-platform library containing exit status and code types"
 repository = "http://crates.lurey.io/proc-result"
 license = "MIT"
-version = "0.2.0"
+version = "0.2.0+1"
 edition = "2024"
 keywords = ["cli", "exit-codes", "sysexit"]
 categories = [

Cargo.toml

@@ -16,19 +16,22 @@ recorded from a Linux process, or vice versa.
 
 ## Usage
 
-Most users of the crate will use the `ToProcResult` trait, which converts the
-result a run of a subprocess to a `ProcResult`, either a successful or an error
-explaining what exit code or (on Unix platforms) the signal the subprocess was
-prematurely terminated with, and is constructed from a
+Most users of the crate will use the `ProcResult` enum, which represents the
+result a run of a explaining what exit code or (on Unix platforms) the signal
+the subprocess was prematurely terminated with, and is constructed from a
 `std::process::ExitStatus`:
 
 ```rust
-use proc_result::ToProcResult;
+use proc_result::ProcResult;
 use std::error::Error;
 use std::process::Command;
 
 fn main() -> Result<(), Box<dyn Error>> {
-    let result = Command::new("ls").status()?.to_proc_result()?;
+    let result: ProcResult = Command::new("ls").status()?.into();
+
+    // Ensures exit code 0.
+    result.ok()?;
+
     Ok(())
 }
 ```