Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mingrammer committed Mar 28, 2020
1 parent 1b4eded commit 9aedc31
Showing 1 changed file with 17 additions and 23 deletions.
40 changes: 17 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,6 @@
<br><br>
# Flog

<h1 align="center">Flog</h1>

<p align="center">
<a href="/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
<a href="https://goreportcard.com/report/github.com/mingrammer/flog"><img src="https://goreportcard.com/badge/github.com/mingrammer/flog"/></a>
<a href="https://travis-ci.com/mingrammer/flog"><img src="https://travis-ci.com/mingrammer/flog.svg?branch=master"/></a>
<a href="https://hub.docker.com/r/mingrammer/flog"><img src="https://img.shields.io/docker/pulls/mingrammer/flog.svg"/></a>
</p>

<p align="center">
A fake log generator for common log formats
</p>

<br><br><br>
[![go report card](https://goreportcard.com/badge/github.com/mingrammer/flog)](https://goreportcard.com/report/github.com/mingrammer/flog) [![travis ci](https://travis-ci.com/mingrammer/flog.svg?branch=master)](https://travis-ci.com/mingrammer/flog) [![docker download](https://img.shields.io/docker/pulls/mingrammer/flog.svg)](https://hub.docker.com/r/mingrammer/flog)

flog is a fake log generator for common log formats such as apache-common, apache error and RFC3164 syslog.

Expand Down Expand Up @@ -86,15 +73,22 @@ flog -t log -f apache_combined -o web/log/apache.log -b 10485760 -p 1048576
flog -f rfc3164 -l
```

## Features
## Supported Formats

- Apache common
- Apache combined
- Apache error
- RFC3164
- RFC5424
- Common log fomat
- JSON

## Supported Outputs

* [X] Completely random log generator
* [ ] Contextual random log generator
* [ ] Statistical random log generator
* [x] Support `apache common`, `apache combined`, `apache error`, `rfc3164`, `rfc5424` and `common log format` log formats
* [ ] Support some other syslog formats
* [x] Support stdout, file and gzip type of logging
- Stdout
- File
- Gzip

## License

MIT
[MIT](LICENSE)

0 comments on commit 9aedc31

Please sign in to comment.