From b6a9ce91c0850b57a3ecac6a637fca74960385c7 Mon Sep 17 00:00:00 2001 From: nitowa Date: Wed, 2 Feb 2022 19:24:21 +0100 Subject: [PATCH] Update readme to reflect on how badly tested this is --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ed966c6..3028cdb 100644 --- a/README.md +++ b/README.md @@ -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**. + +## Operation on the main-net is untested and should not be used in production! +
+ # 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'