diff --git a/README.md b/README.md index 59e519d..56ef6dc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ # alfred -the grabber companion +the grabber companion, it sends computer informations in a json package then send it to the server (grabber) + +## usage + +to use it, clone the git then use this command + +`makeself ./alfred alfred.run ./alfred/alfred.sh` + +## dependencies +- inxi (lastest release) +- jq (1.8.1 tested)