cive/README.md

Cive is an interface for the Conflux Core Space, built on Viem.

# CIVE

Cive is an interface for the Conflux Core Space, built on Viem.

## Install

Use `npm`

```bash
npm install cive
```

Or `pnpm`

```bash
pnpm add cive
```

Or `yarn`

```bash
yarn add cive
```

## Usage

```ts
// 1. Import modules
import { createPublicClient, http } from "cive";
import { mainnet } from "cive/chains";

// 2. Set up client
const publicClient = createPublicClient({
  chain: mainnet,
  transport: http(),
});

// 3. consume an action
const block = await publicClient.getBlock();
```

## Docs

[Head to the documentation](https://cive.zyx.ee/) to read and learn more about cive.

## Licenses

This project is licensed under the [MIT License](LICENSE).

This project also partially contains code derived or copied from the following projects:

- [Viem(MIT)](https://github.com/wevm/viem)
- [Abitype(MIT)](https://github.com/wevm/abitype)