urbit-ob

commit 86d0d8e4dc7fe04d321ca18d42c68c6f60005dbf
parent 7d1c9344a507ed305d3d9efec2ed002f61e192b7
Author: Jared Tobin <jared@jtobin.io>
Date:   Sun,  4 Nov 2018 15:48:08 +1300

Update README. [ci skip]

Diffstat:
M
README.md
 | 
14
++++++++++++--

1 file changed, 12 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -59,8 +59,17 @@ There are a few other noteworthy functions exposed as well:
 * `sein`, for determining the parent of a `@p` value
 * `eqPatq`, for comparing `@q` values for equality
 
-In the third case: `@q` values are considered equal modulo the existence of
-leading zero bytes, so that, for example:
+For example, you can check that `~marzod` is a star with parent `~zod`:
+
+```
+> ob.clan('~marzod')
+'star'
+> ob.sein('~marzod')
+'~zod'
+```
+
+And note that `@q` values are considered equal modulo the existence of leading
+zero bytes:
 
 ```
 > '~doznec-marzod' === '~nec-marzod'
@@ -72,3 +81,4 @@ true
 ## Testing
 
 A simple `npm test` will run the test suite.
+