wymiller/logman
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Create README.md

Browse Source
This commit is contained in:
Wyatt J. Miller 2019-09-28 00:51:50 -04:00 committed by GitHub
parent 11f3648401
commit 2cbbc2940d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md Normal file
View File

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