urbit-hob

commit aa016a902408b1c427bf85fe6d74c2fe5bda0ac1
parent cef0de24a4f0d2695e85e4703d2eadecfa3c9471
Author: Jared Tobin <jared@jtobin.io>
Date:   Fri, 13 Sep 2019 18:47:57 -0230

meta: update description, homepage

Diffstat:
M
urbit-hob.cabal
 | 
22
++++++++++------------

1 file changed, 10 insertions(+), 12 deletions(-)
diff --git a/urbit-hob.cabal b/urbit-hob.cabal
@@ -1,7 +1,7 @@
 name:           urbit-hob
 version:        0.1.0
 synopsis:       Hoon-style atom manipulation and printing functions
-homepage:       https://github.com/urbit/urbit-hob#readme
+homepage:       https://github.com/urbit/urbit-hob
 bug-reports:    https://github.com/urbit/urbit-hob/issues
 author:         Jared Tobin
 maintainer:     jared@jtobin.io
@@ -12,26 +12,24 @@ license-file:   LICENSE
 build-type:     Simple
 cabal-version:  >= 1.10
 description:
-  Here you can primarily find functions for dealing with the "patp" phonetic
-  base used by Urbit.  The '@p' encoding is used for naming ships; it uniquely
+  Here you can primarily find functions for dealing with the \"patp\" phonetic
+  base used by Urbit.  The \@p encoding is used for naming ships; it uniquely
   represents a 32-bit number in a memorable and pronounceable fashion.
   .
-  The '@p' encoding is an obfuscated representation of an underlying 32-bit
-  number, in particular, hence the 'ob' in the library's name.
+  The \@p encoding is an obfuscated representation of an underlying 32-bit
+  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.
+  The @Urbit.Ob@ module exposes two functions, 'patp' and 'fromPatp', for
+  converting between representations.  You can render a 'Patp' value via the
+  'render' function.
   .
   Here's a quick example:
   .
   > import qualified Urbit.Ob as Ob
   >
   > let nidsut = Ob.patp 15663360
-  > Ob.render nidsut
-  "~nidsut-tomdun"
-  > Ob.fromPatp nidsut
-  15663360
+  > Ob.render nidsut   --  "~nidsut-tomdun"
+  > Ob.fromPatp nidsut --  15663360
 
 source-repository head
   type: git