urbit-hob

commit 0e56639fe99ec8226a3b9147917e8aa187853f21
parent 64015f958226fe623c0bbf9078d5bd91d05d5da2
Author: Jared Tobin <jared@jtobin.io>
Date:   Wed, 18 Sep 2019 11:49:34 -0230

version bump (0.1.1 -> 0.2.0)

Diffstat:
M
CHANGELOG
 | 
8
++++++++
M
urbit-hob.cabal
 | 
25
+++++++++++++++----------

2 files changed, 23 insertions(+), 10 deletions(-)
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,5 +1,13 @@
 # Changelog
 
+- 0.2.0 (2019-09-18)
+    * Now uses Natural internally, and thus faithfully supports Hoon atoms of
+      arbitrary size.
+    * Adds the 'parse' function for parsing @p values from Text.
+    * Drops the 'cereal' dependency.
+    * Improves error handling throughout.
+    * Improves Haddocks and in-module documentation.
+
 - 0.1.1 (2019-09-13)
     * Fixes an overflow bug (urbit/urbit-hob#2) that resulted in Urbit.Ob.feis
       returning incorrect results on very rare inputs.
diff --git a/urbit-hob.cabal b/urbit-hob.cabal
@@ -1,5 +1,5 @@
 name:           urbit-hob
-version:        0.1.1
+version:        0.2.0
 synopsis:       Hoon-style atom manipulation and printing functions
 homepage:       https://github.com/urbit/urbit-hob
 bug-reports:    https://github.com/urbit/urbit-hob/issues
@@ -16,20 +16,25 @@ description:
   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
+  The \@p encoding is an /obfuscated/ representation of an underlying 32-bit
   number, in particular, hence the \"ob\" in the library's name.
   .
   The @Urbit.Ob@ module exposes two functions, 'patp' and 'fromPatp', for
-  converting between representations.  You can render a 'Patp' value via the
-  'render' function.
+  converting between representations.  You can also render a 'Patp' value via
+  the 'render' function, or parse one via 'parse'.
   .
-  Here's a quick example:
+  Some quick examples:
   .
-  > import qualified Urbit.Ob as Ob
-  >
-  > let nidsut = Ob.patp 15663360
-  > Ob.render nidsut   --  "~nidsut-tomdun"
-  > Ob.fromPatp nidsut --  15663360
+  >>> :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
 
 source-repository head
   type: git