Add package description and module documentation.

crabmusket · May 30, 2015 · a1115da · a1115da
1 parent b72dbed
commit a1115da
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/hscuid.cabal b/hscuid.cabal
@@ -4,7 +4,8 @@
 name:                hscuid
 version:             0.0.0
 synopsis:            Collision-resistant IDs
--- description:         
+description:         CUIDs are designed for horizontal scalability and collision
+                     resistance. Read more about them at <https://usecuid.org>.
 homepage:            https://github.com/eightyeight/hscuid
 license:             MIT
 license-file:        LICENSE

diff --git a/lib/Web/Cuid.hs b/lib/Web/Cuid.hs
@@ -1,5 +1,16 @@
 {-# LANGUAGE CPP, ForeignFunctionInterface #-}
 
+{-|
+Stability: stable
+Portability: portable
+
+You can generate a new CUID inside any IO-enabled monad using this module's
+one exported function:
+
+>>> cuid <- newCuid
+>>> print cuid
+"ciaafthr00000qhpm0jp81gry"
+-}
 module Web.Cuid (
     Cuid, newCuid
 ) where