Skip to content

Commit

Permalink
add README
Browse files Browse the repository at this point in the history
  • Loading branch information
Sun Ning committed Jul 2, 2012
1 parent 88f1dbb commit 097b805
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
@@ -1,13 +1,26 @@
# timing

A Clojure library designed to ... well, that part is up to you.
Timing is a simple library to log call time using perf4j.

## Usage

FIXME
Just wrap forms you want to calculate call time:

```clojure
(timed :tag
(look-up-db ...)
(assemble-data ...))
```

Note that you have to provide a `tag` to identify these forms in
timing log.

Timing will select a logging provider automatically by looking up your
classpath (slf4j, log4j and stderr). Timing doesn't depend on any
logging provider at compile time.

## License

Copyright © 2012 FIXME
Copyright © 2012 [Sun Ning](http://github.com/sunng87)

Distributed under the Eclipse Public License, the same as Clojure.

0 comments on commit 097b805

Please sign in to comment.