Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
iosh committed Dec 1, 2024
1 parent d249a77 commit dab827e
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Run the Conflux-Rust node in Node.js. This is used for developing on the Conflux network, such as testing RPC dApps or contracts.

# Supported platforms
## Supported platforms

By now xcfx-node supports the following platforms:

Expand All @@ -12,19 +12,19 @@ By now xcfx-node supports the following platforms:

If you want to run other platform or architecture, you can open an [issue](https://github.com/iosh/xcfx-node/issues/new) on GitHub

# Mainnet and testnet
## Mainnet and testnet

If you want to run a mainnet or testnet node, please refer to the [Conflux documentation](https://www.confluxdocs.com/docs/category/run-a-node)

# Quick start
## Quick start

## Install
### Install

```bash
npm install @xcfx/node
```

## Usage
### Usage

```ts
import { createServer } from "@xcfx/node";
Expand All @@ -49,7 +49,7 @@ async function main() {
await main();
```

## Configuration
### Configuration

```ts
import { createServer } from "@xcfx/node";
Expand All @@ -59,7 +59,7 @@ async function main() {
}
```

### confluxConfig
#### confluxConfig

```ts
export interface ConfluxConfig {
Expand Down

0 comments on commit dab827e

Please sign in to comment.