AIR
/
parson
mirror of https://github.com/kgabis/parson.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updates README.md because github changed it's markdown renderer.

Browse Source
pull/70/merge
Krzysztof Gabis 8 years ago
parent 20ad63f8ff
commit dd9eed2af2
1 changed files with 9 additions and 9 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 18
      README.md

18
README.md
Unescape View File

@ -1,7 +1,7 @@
##About ## About
Parson is a lighweight [json](http://json.org) library written in C. Parson is a lighweight [json](http://json.org) library written in C.
##Features ## Features
* Full JSON support * Full JSON support
* Lightweight (only 2 files) * Lightweight (only 2 files)
* Simple API * Simple API
@ -9,7 +9,7 @@ Parson is a lighweight [json](http://json.org) library written in C.
* C89 compatible * C89 compatible
* Test suites * Test suites
##Installation ## Installation
Run: Run:
``` ```
git clone https://github.com/kgabis/parson.git 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. Run ```make test``` to compile and run tests.
##Examples ## Examples
###Parsing JSON ### Parsing JSON
Here is a function, which prints basic commit info (date, sha and author) from a github repository. Here is a function, which prints basic commit info (date, sha and author) from a github repository.
```c ```c
void print_commits_info(const char *username, const char *repo) { 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. In this example I'm using parson to save user information to a file and then load it and validate later.
```c ```c
void persistence_example(void) { 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. Creating JSON values is very simple thanks to the dot notation.
Object hierarchy is automatically created when addressing specific fields. 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. 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. 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. Remember to follow parson's code style and write appropriate tests.
##License ## License
[The MIT License (MIT)](http://opensource.org/licenses/mit-license.php) [The MIT License (MIT)](http://opensource.org/licenses/mit-license.php)

Write Preview
Loading…
Cancel
Save