From 2cbbc2940d3d11e039dc2d5da229927db75a6ae7 Mon Sep 17 00:00:00 2001 From: "Wyatt J. Miller" Date: Sat, 28 Sep 2019 00:51:50 -0400 Subject: [PATCH] Create README.md --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..04b9c32 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# logman +Collecting log files for the greater good! + +This program lets you grab log files (or any file if you wanted to) remotely and store them up into a compressed file on your local machine! + +## Installation + +If you have Go installed, use `go get` for grabbing this repo: + +`go get github.com/wymillerlinux/logman` + +If you don't have Go installed, I will provide binaries soon. + +## Running + +Before you start the program, I would like to highlight the attraction to said program. +The configuration file, `config.yaml`, is where you set everything about where you want +to grab logs from. + +After that, just run the binary and you should be golden. + +## Troubleshooting +The GitHub issue board is where I post issues with the program. If you any issue with the program, please post it there. + +I'm new to Go, so forgive the long wait time for any bux fix. + +## Contributing +If you would like to contribute, feel free to email me or send in pull requests. `todo.md` should have some things to get you rolling.