-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a5b2c50
commit b920dbb
Showing
1 changed file
with
20 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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>. |