diff --git a/README.md b/README.md index e69de29..8e875e2 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,39 @@ +pyAD2 - Python library for the AD2 device family +================================================ + +This Python module aims to provide a consistent interface for all of the AD2 +product line, including the AD2USB, AD2SERIAL and AD2PI devices. This also +includes devices that have been exposed via [ser2sock](http://github.com/nutechsoftware/ser2sock) and supports encryption +via SSL/TLS. + +Installation +------------ + +pyAD2 can be installed through pip: + pip install pyad2 + +or from source: + python setup.py install + +Requirements +------------ +* [pyopenssl](https://launchpad.net/pyopenssl) +* [pyusb](http://sourceforge.net/apps/trac/pyusb/) >= 1.0.0b1 +* [pyserial](http://pyserial.sourceforge.net/) >= 2.7 +* [pyftdi](https://github.com/eblot/pyftdi) >= 0.9.0 + +Documentation +------------- + +API documentation can be found [here](http://github.com/nutechsoftware/pyad2/tree/master/docs/_build/html). + +Examples +-------- + +Basic usage: + +```python + +``` + +Please see the [examples](http://github.com/nutechsoftware/pyad2/tree/master/examples) directory for more.