adds readme

Signed-off-by: Jochen maes <jochen@sejo-it.be>
This commit is contained in:
Jochen Maes 2023-10-16 05:30:51 +02:00
parent 09757baf4a
commit 47aeaa1b5a

26
README.md Normal file
View File

@ -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