Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aybabtme committed Apr 12, 2015
1 parent 3fcdcb9 commit 20c0618
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,8 @@ wget -qO- https://github.com/aybabtme/humanlog/releases/download/0.1.4/humanlog_

# Example

If you emit logs in `logfmt` or using the default logrus TextFormatter, you
will enjoy pretty logs when those entries are encountered by `humanlog`.
Unrecognized lines are left unchanged.

If you emit logs in JSON or in [`logfmt`](https://brandur.org/logfmt), you will enjoy pretty logs when those
entries are encountered by `humanlog`. Unrecognized lines are left unchanged.

```
$ humanlog < /var/log/logfile.log
Expand All @@ -41,7 +39,6 @@ $ humanlog < /var/log/logfile.log
How to help:

* __support more log formats__: by submitting `human.Handler` implementations.
* __following a file__: add support for following a file, alike to `tail -f=name`
* __live querying__: add support for filtering in log output in real time.
* __charting__: some key-values have semantics that could be charted in real time. For
instance, durations, frequency of numeric values, etc. See the [l2met][] project.
Expand All @@ -56,7 +53,7 @@ USAGE:
humanlog [global options] command [command options] [arguments...]
VERSION:
0.0.0
0.1.4
AUTHOR:
Antoine Grondin - <[email protected]>
Expand All @@ -74,5 +71,4 @@ GLOBAL OPTIONS:
--help, -h show help
--version, -v print the version
```

[l2met]: https://github.com/ryandotsmith/l2met
2 changes: 1 addition & 1 deletion cmd/humanlog/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ func newApp() *cli.App {
app.Author = "Antoine Grondin"
app.Email = "[email protected]"
app.Name = "humanlog"
app.Version = "0.1.3"
app.Version = "0.1.4"
app.Usage = "reads structured logs from stdin, makes them pretty on stdout!"

app.Flags = []cli.Flag{skipFlag, keepFlag, sortLongest, skipUnchanged, truncates, truncateLength}
Expand Down

0 comments on commit 20c0618

Please sign in to comment.