README

libtclt
=======

Description
-----------

libtclt is a library that allows the implementation of a tNETacle client.
It encapsulates the JSON-based protocol used to talk to the core.

API
---

Protocol client-core :
   * tclt_add_connection : create a request string to add peer and connect to it
   * tclt_add_key_for_client : create a request string to add a public key to allow a client to connect to the core
   * tclt_add_key_for_peer : create a request string to add a public key to allow a peer to connect to the core
   * tclt_add_peer_to_group : create a request string to add a peer to a group
   * tclt_add_public_key : create a request string to add another public key to a peer
   * tclt_add_tunnel : create a request string to create a tunnel between peers inside a group
   * tclt_clear_group : create a request string to empty a tunnel
   * tclt_clear_peers : create a request string to delete all peers known by the core
   * tclt_create_group : create a request string to create a group
   * tclt_delete_connection : create a request string to disconnect a peer
   * tclt_destroy_group : create a request string to delete a group
   * tclt_edit_config : create a request string to change the core configuration
   * tclt_edit_peer : create a request string to change the peer information
   * tclt_stop_tunnel : create a request string to 

Supported Systems
-----------------

   * OpenBSD
   * Linux
   * NetBSD
   * FreeBSD
   * Darwin
   * Windows

Binding in other languages
--------------------------

   * Ruby

Depends
-------

   * Yajl 2 (You can find it at : https://github.com/lloyd/yajl)

License
-------

All the code is licensed under the ISC License.