summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEric Haszlakiewicz <erh+git@nimenees.com>2016-06-08 02:36:13 +0000
committerEric Haszlakiewicz <erh+git@nimenees.com>2016-06-08 02:37:15 +0000
commitae66b243690871f2daea5ae4b2a4669081d7c556 (patch)
tree96c4968b7385273e354202ec4910d1c46ca9b9d7 /README.md
parent40de3c67cd6d44dc8e17cdf240dd79ab8b1ce1c1 (diff)
downloadjson-c-ae66b243690871f2daea5ae4b2a4669081d7c556.tar.gz
Mention that we're aiming to follow RFC 7159 now.
Cause README.md to show up in Doxygen output as the main page.
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index bcd4e21..76b2140 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,14 @@
-`json-c`
+`json-c` {#mainpage}
========
+JSON-C - A JSON implementation in C
+-----------------------------------
+
+JSON-C implements a reference counting object model that allows you to easily
+construct JSON objects in C, output them as JSON formatted strings and parse
+JSON formatted strings back into the C representation of JSON objects.
+It aims to conform to <a href="https://tools.ietf.org/html/rfc7159">RFC 7159</a>
+
Building on Unix with `git`, `gcc` and `autotools`
--------------------------------------------------