diff --git a/README.md b/README.md index d8805e0..c8b4742 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,15 @@ Rison gets parsed into and serialized from Aeson [Value](http://hackage.haskell. Implementation partly inspired by [Aeson](https://github.com/bos/aeson). +##Example + +``` +{-# LANGUAGE OverloadedStrings #-} +import Data.Rison + +example :: Bool +example = let inputString = "(property:!(val1,val2,val3))" + aesonValue = decode inputString + outputString = encode aesonValue + in inputString == outputString +``` diff --git a/rison.cabal b/rison.cabal index 1408a07..19335b0 100644 --- a/rison.cabal +++ b/rison.cabal @@ -1,7 +1,7 @@ name: rison -version: 0.1.0.0 -synopsis: Support for parsing and rendering RISON strings. -description: Please see README.md +version: 1.0.0.0 +synopsis: Parses and renders RISON strings. +description: Rison gets parsed into and serialized from Aeson Valueobjects. Please see README.md for details. homepage: https://github.com/martinvlk/rison-hs#readme license: BSD3 license-file: LICENSE