Skip to content
This repository has been archived by the owner on Dec 8, 2020. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
binarylogic committed Dec 15, 2016
1 parent bc5541d commit 96c3356
Showing 1 changed file with 24 additions and 8 deletions.
32 changes: 24 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,37 @@


1. [What is timber?](#what-is-timber)
1. [How does it work?](#what-is-timber)
2. [Logging Custom Events](#logging-custom-events)
3. [The Timber Console / Pricing](#the-timber-console-pricing)
2. [Install](#install)
2. [Why timber?](#why-timber)
3. [How does it work?](#how-does-it-work)
4. [Logging Custom Events](#logging-custom-events)
5. [The Timber Console / Pricing](#the-timber-console-pricing)
6. [Install](#install)


## What is Timber?

Timber automatically structures your logs with events and context in a non-proprietary JSON format.
It’s simple, quick, managed, and has absolutely no risk of code debt or lock-in.
It’s just good ol’ logging.
Timber takes a different approach to logging, in that it automatically enriches and structures your
logs without altering the essence of your original log messages. Giving you the best of
both worlds: human readable logs *and* rich structured data.

More importantly, it does so with absolutely no lock-in or risk of code debt. It's just good
ol' logging! For example:

1. The resulting log format, by deafult, is a simple, non-proprietary, JSON structure.
(see [How does it work?](#how-does-it-work) for an example).
2. The `Timber::Logger` class extends `Logger`, and will never change the public API. If you opt
to stop using Timber, your old `Logger` can be swapped in seamlessly.
3. Where you send your logs is entirely up to you, but we hope you'll check out
[timber.io](https://timber.io). We've built a beautiful, modern, and fast console for searching
and visualizing your logs. And because we wrote this library, the interface can make assumptions
about the structure of your data. Making the console really nice to use.


## Why Timber?

Timber’s philosophy is that application insight should be open and owned by you. It should not
require a myriad of services to accomplish. And there is no better, or more complete, vehicle
than logging to solve this:
than logging:

1. It’s a shared practice that has been around since the dawn of computers.
2. It’s baked into every language, library, and framework. Even your own apps.
Expand Down

0 comments on commit 96c3356

Please sign in to comment.