simonflex-framework/README.md

A library implements Meter Flex interface

# Flex Framework

[![npm version](https://badge.fury.io/js/%meterio%2Fflex-framework.svg)](https://badge.fury.io/js/%40meterio%2Fflex-framework)

Flex Framework is a library implements Flex interface.
It helps various wallet instances offer consistent Flex interface to Meter Dapps.

## Installation

```sh
npm i simonflex-framework
```

## Usage

To create framework instance, Flex.Driver needs to be implemented

```typescript
import { Framework } from 'simonflex-framework';
import 'simonflex.driver';

class MyDriver implements Flex.Driver {
  // implementations
}

const driver = new MyDriver();

// it's suggested in development mode, which is helpful to diagnose driver implementation.
// const framework = new Framework(Framework.guardDriver(driver))

const framework = new Framework(driver);

// here `framework` is the ready-to-use Flex instance object
```

## See also

### Flex playground

- [flex repl](https://github.com/meterio/flex-repl)