Skip to content

Commit

Permalink
Update readme to include mix.exs setting and link to hex.pm (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
parroty committed Dec 27, 2015
1 parent a105fc3 commit af8476e
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# ExProf [![Build Status](https://secure.travis-ci.org/parroty/exprof.png?branch=master "Build Status")](http://travis-ci.org/parroty/exprof)
# ExProf [![Build Status](https://secure.travis-ci.org/parroty/exprof.png?branch=master "Build Status")](http://travis-ci.org/parroty/exprof) [![hex.pm version](https://img.shields.io/hexpm/v/exprof.svg)](https://hex.pm/packages/exprof) [![hex.pm downloads](https://img.shields.io/hexpm/dt/exprof.svg)](https://hex.pm/packages/exprof)
A simple code profiler for Elixir using eprof.

It provides a simple macro as a wrapper for Erlang's <a href="http://www.erlang.org/doc/man/eprof.html" target="_blank">:eprof</a> profiler.

### Install
Add `:exprof` to `deps` section of `mix.exs`.

```elixir
def deps do
[ {:exprof, "~> 0.2.0"} ]
end
```

### Usage
import "ExProf.Macro", then use "profile" macro to start profiling. It prints out results, and returns them as list of records.

Expand Down

0 comments on commit af8476e

Please sign in to comment.