Skip to content

Commit f55880d

Browse files
committed
doc: update docs
1 parent b288f6d commit f55880d

File tree

2 files changed

+23
-13
lines changed

2 files changed

+23
-13
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
1+
**English** | [中文](https://github.com/nanmu42/etherscan-api/blob/master/README_ZH.md)
2+
13
# etherscan-api
24

3-
[![Build Status](https://travis-ci.org/nanmu42/etherscan-api.svg?branch=master)](https://travis-ci.org/nanmu42/etherscan-api)
4-
[![Go Report Card](https://goreportcard.com/badge/github.com/nanmu42/etherscan-api)](https://goreportcard.com/report/github.com/nanmu42/etherscan-api)
5-
[![codecov](https://codecov.io/gh/nanmu42/etherscan-api/branch/master/graph/badge.svg)](https://codecov.io/gh/nanmu42/etherscan-api)
65
[![GoDoc](https://godoc.org/github.com/nanmu42/etherscan-api?status.svg)](https://godoc.org/github.com/nanmu42/etherscan-api)
7-
[中文文档](https://github.com/nanmu42/etherscan-api/blob/master/README_ZH.md)
6+
[![CI status](https://github.com/nanmu42/etherscan-api/workflows/build/ci.svg)](https://github.com/nanmu42/etherscan-api/actions)
7+
[![codecov](https://codecov.io/gh/nanmu42/etherscan-api/branch/master/graph/badge.svg)](https://codecov.io/gh/nanmu42/etherscan-api)
8+
[![Go Report Card](https://goreportcard.com/badge/github.com/nanmu42/etherscan-api)](https://goreportcard.com/report/github.com/nanmu42/etherscan-api)
89

9-
Go bindings to the Etherscan.io API(and its families like BscScan), with nearly Full implementation(accounts, transactions, tokens, contracts, blocks, stats), full network support(Mainnet, Ropsten, Kovan, Rinkby, Goerli, Tobalaba), and only depending on standard library. :wink:
10+
Golang client for the Etherscan.io API(and its families like BscScan), with nearly full implementation(accounts, transactions, tokens, contracts, blocks, stats), full network support(Mainnet, Ropsten, Kovan, Rinkby, Goerli, Tobalaba), and only depending on standard library. :wink:
1011

1112
# Usage
1213

13-
Create a API instance and off you go. :rocket:
14+
```bash
15+
go get github.com/nanmu42/etherscan-api
16+
```
17+
18+
Create an API instance and off you go. :rocket:
1419

1520
```go
1621
import (
@@ -70,6 +75,6 @@ I am not from Etherscan and I just find their service really useful, so I implem
7075

7176
# License
7277

73-
Use of this work is governed by a MIT License.
78+
Use of this work is governed by an MIT License.
7479

7580
You may find a license copy in project root.

README_ZH.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
1+
[English](https://github.com/nanmu42/etherscan-api/blob/master/README.md) | **中文**
2+
13
# etherscan-api
24

3-
[![Build Status](https://travis-ci.org/nanmu42/etherscan-api.svg?branch=master)](https://travis-ci.org/nanmu42/etherscan-api)
4-
[![Go Report Card](https://goreportcard.com/badge/github.com/nanmu42/etherscan-api)](https://goreportcard.com/report/github.com/nanmu42/etherscan-api)
5-
[![codecov](https://codecov.io/gh/nanmu42/etherscan-api/branch/master/graph/badge.svg)](https://codecov.io/gh/nanmu42/etherscan-api)
65
[![GoDoc](https://godoc.org/github.com/nanmu42/etherscan-api?status.svg)](https://godoc.org/github.com/nanmu42/etherscan-api)
7-
[English Readme](https://github.com/nanmu42/etherscan-api/blob/master/README.md)
6+
[![CI status](https://github.com/nanmu42/etherscan-api/workflows/build/ci.svg)](https://github.com/nanmu42/etherscan-api/actions)
7+
[![codecov](https://codecov.io/gh/nanmu42/etherscan-api/branch/master/graph/badge.svg)](https://codecov.io/gh/nanmu42/etherscan-api)
8+
[![Go Report Card](https://goreportcard.com/badge/github.com/nanmu42/etherscan-api)](https://goreportcard.com/report/github.com/nanmu42/etherscan-api)
89

9-
Etherscan.io的Golang实现
10+
Etherscan API的Golang客户端
1011
支持几乎所有功能(accounts, transactions, tokens, contracts, blocks, stats),
1112
所有公共网络(Mainnet, Ropsten, Kovan, Rinkby, Goerli, Tobalaba)。
1213
本项目只依赖于官方库。 :wink:
1314

14-
# Usage
15+
# 使用方法
16+
17+
```bash
18+
go get github.com/nanmu42/etherscan-api
19+
```
1520

1621
填入网络选项和API Key即可开始使用。 :rocket:
1722

0 commit comments

Comments
 (0)