Skip to content

Comments

docs: update README with badges and formatting#162

Merged
Tim-Zhang merged 1 commit intokata-containers:mainfrom
gaius-qi:feature/readme
Feb 3, 2026
Merged

docs: update README with badges and formatting#162
Tim-Zhang merged 1 commit intokata-containers:mainfrom
gaius-qi:feature/readme

Conversation

@gaius-qi
Copy link

This pull request updates the README.md to improve clarity and modernize its presentation. The changes focus on enhancing documentation and updating badges and formatting.

Documentation improvements:

  • Updated the project description to clarify that cgroups-rs is a native Rust library for managing Linux control groups, supporting both cgroups v1 and v2.
  • Improved the examples section by adding clearer headings and consistent code formatting for the builder pattern usage.

Presentation and formatting updates:

  • Replaced the Travis CI build badge with crates.io and docs.rs badges for better visibility of crate status and documentation.
  • Changed the "Disclaimer" section heading from a top-level to a secondary heading for better structure.

Copy link
Member

@justxuewei justxuewei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent!

- 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 <gaius.qi@gmail.com>
Copy link
Member

@Tim-Zhang Tim-Zhang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Tim-Zhang Tim-Zhang merged commit acad18f into kata-containers:main Feb 3, 2026
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants