H3 Crystal - Testing

Crystal-to-C bindings for Uber's H3 library.

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

Supported H3 Versions

The semantic versioning of this shard matches the versioning of the H3 C library. E.g. version 3.5.x of this shard is targeted for version 3.5.y of H3 C lib where x and y are independent patch levels.

Getting Started

Before installing the shard, please install the build dependencies for your system as instructed here: https://github.com/uber/h3#install-build-time-dependencies

Installation

1. Add the dependency to your shard.yml:

   dependencies:
     h3_crystal:
       github: swilk19/h3_crystal
   

2. Run shards install

Usage

require "h3_crystal/h3"

TODO: Write usage instructions here

Development

TODO: Write development instructions here

Contributing

1. Fork it (https://github.com/your-github-user/h3_crystal/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• swilkins - creator and maintainer

Special Thanks

• H3 Ruby