Skip to content

Commit

Permalink
prettify README
Browse files Browse the repository at this point in the history
  • Loading branch information
informatikr committed Jun 11, 2011
1 parent a5b2c50 commit b920dbb
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.markdown
Original file line number Original file line Diff line number Diff line change
@@ -1,7 +1,23 @@
# aeson-pretty # Welcome to aeson-pretty


A JSON pretty-printing library compatible with aeson as well as a command-line tool to improve readabilty of streams of JSON data. This is a JSON pretty-printing Haskell library compatible with [aeson](http://hackage.haskell.org/package/aeson) as well as a command-line tool to improve readabilty of streams of JSON data.


The library provides a single function "encodePretty". It is a drop-in replacement for aeson's "encode" function, producing JSON-ByteStrings for human readers. The **library** provides a single function `encodePretty`. It is a drop-in replacement for aeson's `encode` function, producing JSON-ByteStrings for human readers.


The command-line tool reads JSON from stdin and writes prettified JSON to stdout. It also offers a complementary "compact"-mode, essentially the opposite of pretty-printing. The **command-line tool** reads JSON from stdin and writes prettified JSON to stdout. It also offers a complementary "compact"-mode, essentially the opposite of pretty-printing.


# Join in!

We are happy to receive bug reports, fixes, documentation enhancements, and other improvements.

Please report bugs via the
[github issue tracker](http://github.com/informatikr/aeson-pretty/issues).

Master [git repository](http://github.com/informatikr/aeson-pretty):

* `git clone git://github.com/informatikr/aeson-pretty.git`

# Authors

This library is written and maintained by Falko Peters, <falko.peters@gmail.com>.

0 comments on commit b920dbb

Please sign in to comment.