Sha256: ea0a033de3b74b5be21b559ece484c9b0f19c14211257d0dd526d7623630c515

Contents?: true

Size: 1.28 KB

Versions: 1

Compression:

Stored size: 1.28 KB

Contents

# Mapkick

Create beautiful Javascript maps with one line of Ruby. No more fighting with maping libraries!

## Usage

World Map

```erb
<%= mapkick_world Item.all.group(:country).count %>
```

United States Map

```erb
<%= mapkick_usa Item.all.group(:state).count %>
```

## Installation

Add this line to your application's Gemfile:

```ruby
gem "mapkick"
```

And add the javascript files to your views.  These files must be included **before** the helper methods, unless using the `:content_for` option.

For the world map, use:

```erb
<%= javascript_include_tag "/assets/datamaps.world.js", "mapkick" %>
```

For the united states map, use:

```erb
<%= javascript_include_tag "/assets/datamaps.usa.js", "mapkick" %>
```

If you intend to use both the world map, and the united states map, you must use:

```erb
<%= javascript_include_tag "/assets/datamaps.all.js", "mapkick" %>
```

## No Ruby? No Problem

Check out [datamaps.js](https://github.com/markmarkoh/datamaps)

## Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help:

- [Report bugs](https://github.com/blackwatertepes/mapkick/issues)
- Fix bugs and [submit pull requests](https://github.com/blackwatertepes/mapkick/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
mapkick-0.0.0 README.md