From 3eeab4ef1c67c10aac8bbf5df37d82ff2cdd8b31 Mon Sep 17 00:00:00 2001 From: Gaius Date: Fri, 30 Jan 2026 12:39:47 +0800 Subject: [PATCH] docs: improve README formatting and badges - Add crates.io badge - Simplify header and description - Fix markdown heading levels (# -> ##) - Fix code block language annotation spacing - Remove redundant blank lines Signed-off-by: Gaius --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 41c6539..81ff297 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,14 @@ -# cgroups-rs ![Build](https://travis-ci.org/kata-containers/cgroups-rs.svg?branch=master) -Native Rust library for managing control groups under Linux +# cgroups-rs -Both v1 and v2 of cgroups are supported. +[![Crate](https://img.shields.io/crates/v/cgroups-rs.svg)](https://crates.io/crates/cgroups-rs) -# Examples +Native Rust library for managing Linux control groups. Supports both cgroups v1 and v2. -## Create a control group using the builder pattern - -``` rust +## Examples +### Create a control group using the builder pattern +```rust use cgroups_rs::*; use cgroups_rs::cgroup_builder::*; @@ -44,7 +43,7 @@ cg.delete(); // major version change. ``` -# Disclaimer +## Disclaimer This crate is licensed under: