README.md in timber-2.0.5 vs README.md in timber-2.0.6
- old
+ new
@@ -12,34 +12,39 @@
## Overview
Timber for Ruby is an optional upgrade you can install for Ruby apps on the
-[Timber.io logging platform](https://timber.io). It turns your once raw text logs into
-[rich JSON events that contain critical event and context data](https://timber.io/docs/elixir/automatic-schema-and-fields).
-These events conform to the [Timber normalized JSON schema](https://timber.io/docs/app/schema-fields)
-and dramatically improve the quality of your logs; allowing you to filter out the noise and solve
-problems faster.
+[Timber.io logging platform](https://timber.io). Instead of completely replacing your log messages,
+Timber automatically augments your logs with JSON metadata. Essentially turning them into
+[rich events with context](https://timber.io/docs/ruby/events-and-context). This preserves the
+readability of your logs while still dramatically improving the quality of your data.
+The end result: better logging and faster problem solving.
-For example, Timber turns this:
+## How it works
+
+For example, Timber turns this familiar raw text log:
+
```
Sent 200 in 45.ms
```
-Into this:
+Into a rich [`http_server_response` event](https://timber.io/docs/ruby/events-and-context/http-server-response-event/).
```
Sent 200 in 45.2ms @metadata {"dt": "2017-02-02T01:33:21.154345Z", "level": "info", "context": {"user": {"id": 1, "name": "Ben Johnson"}, "http": {"method": "GET", "host": "timber.io", "path": "/path", "request_id": "abcd1234"}}, "event": {"http_server_response": {"status": 200, "time_ms": 45.2}}}
```
-Allowing you to run extremely powerful queries in the [Timber console](https://timber.io/docs/app/overview/) like:
+In the [Timber console](https://app.timber.io) simply
+[click the line to view this metdata](https://timber.io/docs/app/tutorials/view-metadata/).
+Moreover, this data allows you to run powerful queries like:
1. `context.request_id:abcd1234` - View all logs generated for a specific request.
2. `context.user.id:1` - View logs generated by a specific user.
-3. `type:http_response` - View specific events (exceptions, sql queries, etc)
+3. `type:http_server_response` - View specific events (exceptions, sql queries, etc)
4. `http_server_response.time_ms:>=1000` - View slow responses with the ability to zoom out and view them in context (request, user, etc).
-5. `level:error` - Levels in your logs!
+5. `level:info` - Levels in your logs!
For a complete overview, see the [Timber for Ruby docs](https://timber.io/docs/ruby/overview/).
## Installation
\ No newline at end of file