README.md

[![Build Status](https://travis-ci.org/helium/ecc_compact.svg?branch=master)](https://travis-ci.org/helium/ecc_compact)
[![Coverage Status](https://coveralls.io/repos/github/helium/ecc_compact/badge.svg?branch=master)](https://coveralls.io/github/helium/ecc_compact?branch=master)


Overview
--------

This library is a utility module to help with point-compression techniques
for NIST P-256 and SEC-2 K-256 elliptic curve public keys. Refer to the
documentation (built using `make doc`) for more information.

Building
--------

Simply use `make` to build the library.

Limitations
-----------

This library only supports point-compaction for NIST P-256 keys and point
compression for SEC-2 K-256 keys. Other curves and compression combinations
could be supported, but the work has not yet been done. Contributions welcome.