commit f94ecc0a8d57587f13d7d69f5c256e13fa5f6fe9
parent 0e56639fe99ec8226a3b9147917e8aa187853f21
Author: Jared Tobin <jared@jtobin.io>
Date: Wed, 18 Sep 2019 12:11:26 -0230
readme: update [ci skip]
Diffstat:
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -19,17 +19,20 @@ number, in particular, hence the 'ob' in the library's name.
The library exposes two functions, `patp` and `fromPatp`, for converting
between representations. You can render a `patp` value via the `render`
-function.
+function, and parse one from Text via `parse`.
Here's a quick example:
```
+> :set -XOverloadedStrings
> import qualified Urbit.Ob as Ob
> let nidsut = Ob.patp 15663360
> Ob.render nidsut
"~nidsut-tomdun"
> Ob.fromPatp nidsut
15663360
+> Ob.parse "~nidsut-tomdun"
+Right ~nidsut-tomdun
```
## See also