> ## Documentation Index
> Fetch the complete documentation index at: https://docs.polygon.technology/llms.txt
> Use this file to discover all available pages before exploring further.

# Usage

> How to install the Chain Indexer Framework and run the provided example pipelines.

<Note title="Git repo and contact details">
  * For details about the technical architecture and to contribute, see the [GitHub repository](https://github.com/0xPolygon/chain-indexer-framework).
  * For questions, reach out on the [Polygon R\&D Discord](https://discord.com/invite/0xpolygonrnd).
</Note>

## Installation

Install the package using npm or Yarn.

### npm

```bash theme={null}
npm install @maticnetwork/chain-indexer-framework
```

### Yarn

```bash theme={null}
yarn add @maticnetwork/chain-indexer-framework
```

## Import the module

```jsx theme={null}
// Import the chain-indexer-framework module
const chain-indexer-framework = require('@maticnetwork/chain-indexer-framework');
```

## Examples

The repository includes two prebuilt examples that cover the full producer-transformer-consumer pipeline:

* [MATIC transfer indexer](https://github.com/0xPolygon/chain-indexer-framework/blob/main/examples/matic_transfer/README.md): indexes MATIC transfer events from the Ethereum blockchain.
* [NFT balancer](https://github.com/0xPolygon/chain-indexer-framework/blob/main/examples/nft_balancer/README.md): indexes NFT transfers and maintains NFT balances.

See the [examples README](https://github.com/0xPolygon/chain-indexer-framework/blob/main/examples/README.md) for setup instructions.