Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
iosh committed Aug 30, 2024
1 parent 426edcf commit 5374c53
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion src/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,32 @@
# CIVE
Cive is an interface for the Conflux Core Space, built on Viem.

⚠️ Note: cive is currently in heavy development and may be unstable. The API is subject to change without prior notice.

## Install

```bash
pnpm 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.

0 comments on commit 5374c53

Please sign in to comment.