README.txt
==========

Introduction
------------

Onion is a library for interacting with Tor. Onion is in an alpha state and is
made available for early adopters and contributors only.

Basic Concepts
--------------

Elements are pieces of the Tor network. Routers, circuits, and streams are
examples of elements. You don't care about how the library gets these, you
just want to be able to interact with them. Methods in the Control Client
return elements.

Parsers take information received from Tor and turn the information into
elements. Parsers are used internally by the Control Client to create elements
to return to the user.

The Control Client is what you can use in scripts to interact with Tor.

Authors
-------

Onion was written by Tim Sally <poet@stack.io>. Please send bug reports and
suggestions to the author.

License
-------

Copyright (c) 2010 Tim Sally and provided under the MIT License. Please see
LICENSE.txt for details.