Skip to content

Commit

Permalink
Add some more to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lnbc1QWFyb24 committed Aug 10, 2022
1 parent fd010b6 commit f61422a
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

A simple JavaScript libary for decoding [runes](https://github.com/rustyrussell/runes).

**Still in Beta and may have some bugs and may have breaking API changes in future**

## Install

Install directly from the repo:
Expand Down Expand Up @@ -43,3 +45,5 @@ console.log(decoded)
// ]
// }
```

If a rune is invalid, `null` will be returned.

0 comments on commit f61422a

Please sign in to comment.