Update readme to reflect on how badly tested this is
This commit is contained in:
@@ -12,6 +12,12 @@ xrpio is a library that allows you to write and read arbitrary data in the rippl
|
||||
npm i xrpio
|
||||
```
|
||||
|
||||
# Caution
|
||||
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**.
|
||||
|
||||
## <span style="color:red"> Operation on the main-net is untested and should not be used in production! </span>
|
||||
<br />
|
||||
|
||||
# Quickstart
|
||||
```typescript
|
||||
import {RippleAPI} from 'ripple-lib'
|
||||
@@ -34,7 +40,7 @@ const data = await treeRead(api, [dataRootHash])
|
||||
console.log(data) //"Arbitrary string data 123"
|
||||
```
|
||||
|
||||
# A simple run-ready example for the testnet
|
||||
# A simple ready-to-run example for the testnet
|
||||
```typescript
|
||||
import { treeRead, treeWrite, Wallet } from 'xrpio'
|
||||
import { RippleAPI } from 'ripple-lib'
|
||||
|
||||
Reference in New Issue
Block a user