浏览代码

Update readme to reflect on how badly tested this is

master
nitowa 3 年前
父节点
当前提交
b6a9ce91c0
共有 1 个文件被更改,包括 7 次插入1 次删除
  1. 7
    1
      README.md

+ 7
- 1
README.md 查看文件

12
 npm i xrpio
12
 npm i xrpio
13
 ```
13
 ```
14
 
14
 
15
+# Caution
16
+This library is in an early stage of development and **breaking changes may occur spontaneously and without regard of semantic versioning until the v1.0.0 release**.
17
+
18
+## <span style="color:red"> Operation on the main-net is untested and should not be used in production! </span>
19
+<br />
20
+
15
 # Quickstart
21
 # Quickstart
16
 ```typescript
22
 ```typescript
17
 import {RippleAPI} from 'ripple-lib'
23
 import {RippleAPI} from 'ripple-lib'
34
 console.log(data) //"Arbitrary string data 123"
40
 console.log(data) //"Arbitrary string data 123"
35
 ```
41
 ```
36
 
42
 
37
-# A simple run-ready example for the testnet
43
+# A simple ready-to-run example for the testnet
38
 ```typescript
44
 ```typescript
39
 import { treeRead, treeWrite, Wallet } from 'xrpio'
45
 import { treeRead, treeWrite, Wallet } from 'xrpio'
40
 import { RippleAPI } from 'ripple-lib'
46
 import { RippleAPI } from 'ripple-lib'

正在加载...
取消
保存