logman/README.md

29 lines
1004 B
Markdown
Raw Normal View History

2019-09-27 23:51:50 -05:00
# 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.