README.hbs

# Eth Registry

[![Greenkeeper badge](https://badges.greenkeeper.io/ethtective/cafe.svg)](https://greenkeeper.io/) [![Build
Status](https://travis-ci.com/Cygnusfear/theregistry.npm.svg?token=J95RxJssBScLdG1sc76e&branch=master)](https://travis-ci.com/ethtective/cafe)
[![code style:
prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Ethereum Dapp
Badge](https://img.shields.io/badge/web3-app-00ffd9.svg?longcache=true&logo=Ethereum&logoColor=white&style=flat&logoWidth=12)](http://www.ethereum.org)

A Node.js module to easily retrieve address metadata from Eth Registry's Ethereum contract.

https://ethregistry.org

# Setup

Usage:

`yarn add theregistry`

# API

{{>main}}

# Development

- `npm run clean` - Remove `lib/` directory
- `npm test` - Run tests with linting and coverage results.
- `npm test:only` - Run tests without linting or coverage.
- `npm test:watch` - You can even re-run tests on file changes!
- `npm test:prod` - Run tests with minified code.
- `npm run test:examples` - Test written examples on pure JS for better understanding module usage.
- `npm run lint` - Run ESlint with airbnb-config
- `npm run cover` - Get coverage report for your code.
- `npm run build` - Babel will transpile ES6 => ES5 and minify the code.
- `npm run prepublish` - Hook for npm. Do all the checks before publishing your module.

# License

MIT © Alexander Mangel