From 47aeaa1b5ad6b39d4f86725fecbfc9f2db2095eb Mon Sep 17 00:00:00 2001 From: Jochen maes Date: Mon, 16 Oct 2023 05:30:51 +0200 Subject: [PATCH] adds readme Signed-off-by: Jochen maes --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..69a0d18 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Mouse + +## Name + +In the factual history book of Douglas Adams, The hitchikers guide to the galaxy, the mice are the gatherers of information and calculators for the problem "The answer to life, universe and all". +Hence mouse :D. + +## Whut? + +Mouse is a rust based facts gatherer that returns a list of facts of the host, it can be completely ran as user at this time and it's intended to stay that way. +Mouse does not alter the system, just gathers information and returns it in a key/value way (with extra epoch timestamp). + +## Why? + +Yes we have ohai, facter, osquery,... +But those won't let me learn Rust. + +## Contribute? + +Why not, but don't feel obligated. + +## I have more questions: + +matrix: @sejo:matrix.sejo-it.be +discord: sejoit (legacy: sejo#5402) +email: jochen@sejo-it.be \ No newline at end of file