diff --git a/README.md b/README.md index e0afa10..432f027 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -##About +## About Parson is a lighweight [json](http://json.org) library written in C. -##Features +## Features * Full JSON support * Lightweight (only 2 files) * Simple API @@ -9,7 +9,7 @@ Parson is a lighweight [json](http://json.org) library written in C. * C89 compatible * Test suites -##Installation +## Installation Run: ``` git clone https://github.com/kgabis/parson.git @@ -18,8 +18,8 @@ and copy parson.h and parson.c to you source code tree. Run ```make test``` to compile and run tests. -##Examples -###Parsing JSON +## Examples +### Parsing JSON Here is a function, which prints basic commit info (date, sha and author) from a github repository. ```c void print_commits_info(const char *username, const char *repo) { @@ -75,7 +75,7 @@ Date SHA Author ... ``` -###Persistence +### Persistence In this example I'm using parson to save user information to a file and then load it and validate later. ```c void persistence_example(void) { @@ -98,7 +98,7 @@ void persistence_example(void) { } ``` -###Serialization +### Serialization Creating JSON values is very simple thanks to the dot notation. Object hierarchy is automatically created when addressing specific fields. In the following example I create a simple JSON value containing basic information about a person. @@ -136,10 +136,10 @@ Output: } ``` -##Contributing +## Contributing I will always merge *working* bug fixes. However, if you want to add something new to the API, please create an "issue" on github for this first so we can discuss if it should end up in the library before you start implementing it. Remember to follow parson's code style and write appropriate tests. -##License +## License [The MIT License (MIT)](http://opensource.org/licenses/mit-license.php)