@nimiq/hub-api/README.md

The Nimiq Hub provides a unified interface for all Nimiq accounts, addresses, and contracts. It is the primary UI for Nimiq users to manage their accounts and provides websites and apps with a concise API to interact with their users’ Nimiq addresses.

# Nimiq Hub API

The Nimiq Hub provides a unified interface for all Nimiq accounts, addresses, and
contracts. It is the primary UI for Nimiq users to manage their accounts and provides
websites and apps with a concise API to interact with their users’ Nimiq addresses.

## Installation

Install the package with `npm` or `yarn`:

```bash
npm install --save @nimiq/hub-api
# or with yarn
yarn add @nimiq/hub-api
```

Then import or require it in your code:

```javascript
import HubApi from '@nimiq/hub-api';
// or
const HubApi = require('@nimiq/hub-api');
```

## Documentation

The documentation for the Hub API is at https://nimiq.github.io/hub.