summaryrefslogtreecommitdiffstats
path: root/third_party/rust/whatsys/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/rust/whatsys/README.md')
-rw-r--r--third_party/rust/whatsys/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/third_party/rust/whatsys/README.md b/third_party/rust/whatsys/README.md
new file mode 100644
index 0000000000..7c6f308deb
--- /dev/null
+++ b/third_party/rust/whatsys/README.md
@@ -0,0 +1,35 @@
+# `whatsys` -- What's this?
+
+[![Crates.io version](https://img.shields.io/crates/v/whatsys.svg?style=flat-square)](https://crates.io/crates/whatsys)
+[![docs.rs docs](https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square)](https://docs.rs/whatsys)
+[![License: MIT](https://img.shields.io/github/license/badboy/whatsys?style=flat-square)](LICENSE)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/badboy/whatsys/ci.yml?branch=main&style=flat-square)](https://github.com/badboy/whatsys/actions/workflows/ci.yml?query=workflow%3ACI)
+
+What kernel version is running?
+
+# Example
+
+```rust
+let kernel = whatsys::kernel_version(); // E.g. Some("20.3.0")
+```
+
+# Supported operating systems
+
+We support the following operating systems:
+
+* Windows
+* macOS
+* Linux
+* Android
+
+# License
+
+MIT. See [LICENSE](LICENSE).
+
+Based on:
+
+* [sys-info](https://crates.io/crates/sys-info), [Repository](https://github.com/FillZpp/sys-info-rs), [MIT LICENSE][sys-info-mit]
+* [sysinfo](https://crates.io/crates/sysinfo), [Repository](https://github.com/GuillaumeGomez/sysinfo), [MIT LICENSE][sysinfo-mit]
+
+[sys-info-mit]: https://github.com/FillZpp/sys-info-rs/blob/master/LICENSE
+[sysinfo-mit]: https://github.com/GuillaumeGomez/sysinfo/blob/master/LICENSE