Browse Source

Update readme to reflect on how badly tested this is

master
nitowa 2 years ago
parent
commit
b6a9ce91c0
1 changed files with 7 additions and 1 deletions
  1. 7
    1
      README.md

+ 7
- 1
README.md View File

@@ -12,6 +12,12 @@ xrpio is a library that allows you to write and read arbitrary data in the rippl
12 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 21
 # Quickstart
16 22
 ```typescript
17 23
 import {RippleAPI} from 'ripple-lib'
@@ -34,7 +40,7 @@ const data = await treeRead(api, [dataRootHash])
34 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 44
 ```typescript
39 45
 import { treeRead, treeWrite, Wallet } from 'xrpio'
40 46
 import { RippleAPI } from 'ripple-lib'

Loading…
Cancel
Save