diff --git a/README.md b/README.md index 4232625..b879ff4 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,27 @@ -# Archspec (Rust bindings) +# archspec-rs -Archspec provides standardized human-readable labels for aspects and capabilities of a system with functions to query and compare them. +[![Crates.io][crates-badge]][crates-url] +![License][license-badge] +[![Build Status][build-badge]][build] +[![Project Chat][chat-badge]][chat-url] +[![docs][docs-badge]][docs-url] -The original bindings in Python can be found at https://github.com/archspec/archspec and exposes a similar API but with some constructs adapted to a more ergonomic Rust style. +[license-badge]: https://img.shields.io/crates/l/archspec?style=flat-square +[build-badge]: https://img.shields.io/github/actions/workflow/status/prefix-dev/archspec-rs/rust-compile.yml?style=flat-square&branch=main +[build]: https://github.com/mamba-org/prefix-dev/archspec-rs +[chat-badge]: https://img.shields.io/discord/1082332781146800168.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2&style=flat-square +[chat-url]: https://discord.gg/kKV8ZxyzY4 +[docs-badge]: https://img.shields.io/badge/docs-main-yellow.svg?style=flat-square +[docs-url]: https://docs.rs/archspec +[crates-badge]: https://img.shields.io/crates/v/archspec.svg?style=flat-square +[crates-url]: https://crates.io/crates/archspec + +An implementation of [archspec](https://github.com/archspec/archspec) in Rust. + +Archspec aims at providing a standard set of human-understandable labels for various aspects of a system architecture like CPU, network fabrics, etc. and APIs to detect, query and compare them. + +The original archspec project grew out of [Spack](https://spack.io/) and is currently under active development. +At present it supports APIs to detect and model compatibility relationships among different CPU microarchitectures. ## License @@ -17,4 +36,4 @@ at your option. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any -additional terms or conditions. \ No newline at end of file +additional terms or conditions.