From 6f1fb7812d8d3987d395edb478845f06852b973f Mon Sep 17 00:00:00 2001 From: Ilya Portnov Date: Sun, 25 Apr 2010 22:14:58 +0600 Subject: [PATCH] Add README. --- README | 20 ++++++++++++++++++++ 1 files changed, 20 insertions(+), 0 deletions(-) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..50f151e --- /dev/null +++ b/README @@ -0,0 +1,20 @@ +YAML-RPC README +=============== +Ilya V. Portnov + +The yaml-rpc package contains a small library to organize remote procedure call +(RPC) over TCP/IP network, using YAML as data serialization format. + +RPC server should supply a set of "RPC methods", which are simply functions :: +a -> IO b, `a' and 'b' should be of class IsYamlObject. This class guarantees +that values of given type can be serialized to YAML and de-serialized. +Network.YAML.Instances module provides some instances declaration for this +typeclass. Moreover, Network.YAML.Derive module contains (TemplateHaskell) +function deriveIsYamlObject, which will help you to declare `instance +IsYamlObject ...' for almost any ADT. + +You can see examples of usage in files Test.hs and TestCall.hs. Haddock +documentation is here: http://iportnov.ru/files/yaml-rpc/html/index.html. + +Depends: ghc >= 6.10, network, data-object, data-object-yaml, yaml, +data-default, convertible-text. -- 1.7.2.3