|
1 | 1 | # AnyWeb JS SDK |
2 | 2 |
|
3 | | -JavaScript AnyWeb Software Development Kit is a complete library for interacting with the AnyChain in both Node.js and |
4 | | -browser environment. |
| 3 | +AnyWeb JS SDK 是为 Anyweb 开发的SDK,提供了一套简单的API,方便开发者快速将 Dapp 接入到 AnyWeb 中实现便捷的钱包服务。 |
5 | 4 |
|
6 | 5 | Features: |
7 | 6 |
|
8 | | -* Support for Mobile and Desktop |
9 | | -* Support H5 without plugin |
10 | | -* Support for multiple chains |
11 | | -* Support hot Wallet and cold Wallet |
12 | | -* Easy to use for developers |
| 7 | +* 支持在移动端和PC端调用钱包服务 |
| 8 | +* 支持网页内和跳转App调用钱包服务 |
| 9 | +* 支持多链钱包服务 |
| 10 | +* 支持 ` 热钱包 ` 和 ` 冷钱包 ` |
| 11 | +* 简单易用快速上手 |
13 | 12 |
|
14 | | -## Docs |
15 | | - |
16 | | -* [Home](README.md) |
17 | | -* [Quick Start](docs/quick_start.md) |
18 | | -* [API](docs/api/modules.md) |
19 | | - * [Provider](docs/api/classed/defaults.md) |
20 | | -* [Release notes](CHANGELOG.md) |
21 | | -* |
| 13 | +## 支持性 |
22 | 14 |
|
23 | | -Check [SDK's documentation](https://wiki.anyweb.cc) site for more info. |
| 15 | +### 已支持 |
24 | 16 |
|
25 | | -## Install |
| 17 | +* Conflux |
26 | 18 |
|
27 | | -Install through npm |
| 19 | +### 待支持 |
28 | 20 |
|
29 | | -```sh |
30 | | -$ npm install --save anyweb-js-sdk |
31 | | -``` |
| 21 | +* Conflux EVM Space |
32 | 22 |
|
33 | | -## How to import |
| 23 | +## Docs |
34 | 24 |
|
35 | | -### Nodejs |
| 25 | +* [介绍](https://wiki.anyweb.cc/docs/intro) |
| 26 | +* [快速开始](https://wiki.anyweb.cc/docs/quick_start) |
| 27 | +* [API](https://wiki.anyweb.cc/docs/API/modules) |
| 28 | + * [Provider](https://wiki.anyweb.cc/docs/API/classes/default) |
| 29 | +* [Release notes](https://wiki.anyweb.cc/docs/CHANGELOG) |
36 | 30 |
|
37 | | -Use in Node.js script |
| 31 | +前往[ 官网文档 ](https://wiki.anyweb.cc)了解更多 |
38 | 32 |
|
39 | | -```javascript |
40 | | -import * from 'anyweb-js-sdk'; |
| 33 | +## 开始之前 |
41 | 34 |
|
42 | | -const conflux = new Provider({ |
43 | | - logger: console, |
44 | | - appId: 'Your app id which get from open.anyweb.cc', |
45 | | -}) |
46 | | -``` |
| 35 | +请先在[ AnyWeb开放平台 ](https://open.anyweb.cc)注册账号获取到AppId等相关信息。 |
47 | 36 |
|
48 | | -### Frontend |
| 37 | +## 安装 |
49 | 38 |
|
50 | | -#### umd |
| 39 | +` npm ` 安装 |
51 | 40 |
|
52 | | -The front packed package is located in `anyweb-js-sdk`'s dist folder. |
53 | | - |
54 | | -```javascript |
55 | | -import { Conflux } from 'anyweb-js-sdk/dist/anyweb-js-sdk.umd.min.js'; |
| 41 | +```sh |
| 42 | +$ npm install --save anyweb-js-sdk |
56 | 43 | ``` |
57 | 44 |
|
58 | | -or if your bundler supports the [`browser` field](https://docs.npmjs.com/files/package.json#browser) in `package.json` |
| 45 | +## 引用方法 |
| 46 | + |
| 47 | +### ESM |
59 | 48 |
|
60 | 49 | ```javascript |
61 | | -import * from 'anyweb-js-sdk'; |
| 50 | +import { Provider } from 'anyweb-js-sdk'; |
| 51 | + |
| 52 | +const provider = new Provider({ |
| 53 | + logger: console, |
| 54 | + appId: '从open.anyweb.cc拿到的AppId', |
| 55 | +}); |
62 | 56 | ``` |
63 | 57 |
|
64 | | -or |
| 58 | +### UMD |
| 59 | + |
| 60 | +从 `anyweb-js-sdk` 的 `dist` 目录中进行引用 `umd` 版本. |
65 | 61 |
|
66 | 62 | ```html |
67 | 63 |
|
68 | 64 | <script type="text/javascript" src="node_modules/anyweb-js-sdk/dist/anyweb-js-sdk.umd.min.js"></script> |
69 | 65 | <script type="text/javascript"> |
70 | | - const anyweb = new window.AnyWeb({ |
| 66 | + const provider = new window.AnyWeb({ |
71 | 67 | logger: console, |
72 | | - appId: 'Your app id which get from open.anyweb.cc' |
| 68 | + appId: '从open.anyweb.cc拿到的AppId' |
73 | 69 | }) |
74 | 70 | </script> |
75 | 71 | ``` |
0 commit comments