Sha256: 89ec5a58b5098017707495939597ee11f92c7cf88e5c14f2b89e9e67de447048

Contents?: true

Size: 1.27 KB

Versions: 1

Compression:

Stored size: 1.27 KB

Contents

# H3 Ruby

![h3](https://user-images.githubusercontent.com/98526/50283275-48177300-044d-11e9-8337-eba8d3cc88a2.png)

[![Build Status](https://travis-ci.org/StuartApp/h3_ruby.svg?branch=master)](https://travis-ci.org/seanhandley/h3_ruby) [![Maintainability](https://api.codeclimate.com/v1/badges/c55e1f67421eba8af8d0/maintainability)](https://codeclimate.com/repos/5c18b7f49bc79a02a4000d81/maintainability)

Ruby bindings for Uber's [H3 library](https://uber.github.io/h3/).

Please consult the H3 documentation for a full explanation of terminology and concepts.

## Getting Started

You need to install the C lib at https://github.com/uber/h3.

Install the build dependencies as instructed here: https://github.com/uber/h3#install-build-time-dependencies

Do *not* follow the Compilation Steps. Instead, use the following:

    git clone git@github.com:uber/h3.git h3_build
    cd h3_build
    cmake . -DBUILD_SHARED_LIBS=true
    make
    sudo make install

The key difference is the `BUILD_SHARED_LIBS` option.

## Installing

    gem install h3

or

    # Gemfile
    gem "h3", "~> 3.2"

## Documentation

https://www.rubydoc.info/github/StuartApp/h3_ruby

## Usage

```ruby
require "h3"
H3.geo_to_h3([53.959130, -1.079230], 8).to_s(16)
# => "8819429a9dfffff"
```

## Running Specs

    rake

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
h3-3.2.0 README.md