From e809c19e54e0c13a3d882d74082d8b847fab1715 Mon Sep 17 00:00:00 2001 From: Sylvestre Ledru Date: Sat, 17 Feb 2024 18:06:45 +0100 Subject: [PATCH] update of the readme --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 9e291406..70cc6733 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,10 @@ +[![Crates.io](https://img.shields.io/crates/v/procps.svg)](https://crates.io/crates/procps) +[![Discord](https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat)](https://discord.gg/wQVJbvJ) +[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/uutils/procps/blob/main/LICENSE) +[![dependency status](https://deps.rs/repo/github/uutils/procps/status.svg)](https://deps.rs/repo/github/uutils/procps) + +[![CodeCov](https://codecov.io/gh/uutils/procps/branch/master/graph/badge.svg)](https://codecov.io/gh/uutils/procps) + # procps Rust reimplementation of the procps project @@ -28,3 +35,20 @@ Elsewhere: * `kill` is already implemented in https://github.com/uutils/coreutils * `uptime`: Shows how long the system has been running, including load average. is already implemented in https://github.com/uutils/coreutils + +## Installation + +Ensure you have Rust installed on your system. You can install Rust through [rustup](https://rustup.rs/). + +Clone the repository and build the project using Cargo: + +```bash +git clone https://github.com/uutils/procps.git +cd procps +cargo build --release +cargo run --release +``` + +## License + +procps is licensed under the MIT License - see the `LICENSE` file for details