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

Add example images to readme #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add example images to readme #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

Simple Heatmap generator for Ruby.


## Examples

![Small data example](https://raw.github.com/tjackiw/heatmap/master/examples/simple.png)
– [Small data example](heatmap/blob/master/examples/simple.rb)

![Large data example](https://raw.github.com/tjackiw/heatmap/master/examples/large.png)
– [Large data example](heatmap/blob/master/examples/large.rb)

More about those examples in the [example directory](heatmap/tree/master/examples).


## Prerequisites

This gem requires *ImageMagick* to run. You can easily install it with *homebrew*:
Expand Down Expand Up @@ -52,11 +64,6 @@ map << Heatmap::Area.new(x, y, alpha)
map.output(filename)
```

## Example

Examples are included in the *examples* directory.


## Contributing to heatmap

* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
Expand All @@ -73,4 +80,4 @@ Examples are included in the *examples* directory.

## Copyright

Copyright (c) 2013 Thiago Jackiw. See LICENSE.txt for further details.
Copyright (c) 2013 Thiago Jackiw. See LICENSE.txt for further details.