[jsonrpc-glib] update README.md



commit 9be9644385b124e438019fa363306d399791b353
Author: Christian Hergert <chergert redhat com>
Date:   Sun Jun 18 20:13:29 2017 -0700

    update README.md

 README.md |   21 +++++++++++++++++++++
 1 files changed, 21 insertions(+), 0 deletions(-)
---
diff --git a/README.md b/README.md
index e69de29..08d2056 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,21 @@
+# Jsonrpc-GLib
+
+Jsonrpc-GLib is a library to communicate with JSON-RPC based peers in either a synchronous or asynchronous 
fashion.
+It also allows communicating using the GVariant serialization format instead of JSON when both peers support 
it.
+You might want that when communicating on a single host to avoid parser overhead and memory-allocator 
fragmentation.
+
+## Building
+
+We use the Meson build system for building jsonrpc-glib.
+
+```sh
+# Some common options
+meson --prefix=/opt/gnome --libdir=/opt/gnome/lib -Denable_gtk_doc=true build
+cd build
+ninja install
+```
+
+## Documentation
+
+You can read the documentation online at https://people.gnome.org/~chergert/docs/jsonrpc-glib/
+


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]