Browse Source

update README

master
nitowa 2 years ago
parent
commit
d2bd9dca0c
2 changed files with 5 additions and 2 deletions
  1. 4
    1
      README.md
  2. 1
    1
      package.json

+ 4
- 1
README.md View File

44
 data = await api.treeRead([txHash])
44
 data = await api.treeRead([txHash])
45
 
45
 
46
 console.log(data) //"arbitrary text 123"
46
 console.log(data) //"arbitrary text 123"
47
+```
47
 
48
 
49
+# Known Bugs
50
+- When using large data (>300kB) and public nodes, the writing process may fail due to rate limits. xrpio will attempt to mitigate this, but success is inconsistent.
51
+- xrpio will occasionally leave behind residual socket connections and timed intervals. This is an issue with the underlying xrpl library. A pull request was submitted and we are witing for the fix.
48
 
52
 
49
-```
50
 
53
 
51
 # [Full documentation](https://gitea.nitowa.xyz/docs/xrpio)
54
 # [Full documentation](https://gitea.nitowa.xyz/docs/xrpio)

+ 1
- 1
package.json View File

1
 {
1
 {
2
   "name": "xrpio",
2
   "name": "xrpio",
3
-  "version": "0.1.1",
3
+  "version": "0.1.2",
4
   "repository": {
4
   "repository": {
5
     "type": "git",
5
     "type": "git",
6
     "url": "https://gitea.nitowa.xyz/npm-packages/xrpio.git"
6
     "url": "https://gitea.nitowa.xyz/npm-packages/xrpio.git"

Loading…
Cancel
Save