[doc] add README.md, MANIFEST.in, AUTHORS, CHANGES and COPYING files

git-svn-id: http://devedge.bour.cc/svn/pyajam/trunk@268 ff29af12-de15-47db-b328-d843b730dfdc

AUTHORS

@@ -0,0 +1,2 @@
+
+main developper: Guillaume Bour <guillaume@bour.cc>

CHANGES

@@ -0,0 +1,5 @@
+
+0.1 - initial release
+
+0.1.1 - docs
+	add README.md, MANIFEST.in, AUTHORS, CHANGES and COPYING files

MANIFEST.in

@@ -0,0 +1,4 @@
+
+include AUTHORS
+include COPYING
+include README.md

README.md

@@ -0,0 +1,64 @@
+PyAjam
+======
+
+[AJAM](http://www.voip-info.org/wiki/view/Aynchronous+Javascript+Asterisk+Manager+%28AJAM%29)(Asynchronous Javascript Asterisk Manager) is the new interface build upon HTTP to interact with Asterisk. 
+AJAM was Introduced in asterisk 1.4. Returned datas are mostly formatted in XML.
+
+[PyAjam](http://devedge.bour.cc/wiki/PyAjam) is pa python library allowing
+programs to interact with an asterisk server using the AJAM interface, in
+a pythonic way.
+
+
+###Requirements:
+* [4Suite-XML](http://pypi.python.org/pypi/4Suite-XML)
+
+###Compatility:
+*	python 2.[4-7]
+
+###Installation
+	easy_install PyAjam
+
+or
+
+	wget http://devedge.bour.cc/resources/PyAjam/src/pyajam.latest.tar.gz
+	tar xvf pyajam.latest.tar.gz
+	cd reblok-* && ./setup.py install
+
+Features
+--------
+
+* retrieve basic informations (sip/iax2 peers, sip peer details, sip registry)
+* catch asterisk events
+* information presented in a pythonic way (dict)
+* automatically reconnect to the asterisk server if connection lost
+* compatible with asterisk 1.4 and 1.6
+
+Documentation
+-------------
+
+You can found PyAjam documentation at [http://devedge.bour.cc/resources/pyajam/doc/index.html](http://devedge.bour.cc/resources/pyajam/doc/index.html)
+
+Example
+-------
+
+	>>> ajam = Pyajam(server='192.168.0.10', username='mspencer', password='*rocks!')
+	>>> if not ajam.login():
+	>>>		print "Invalid login"
+	>>>		sys.exit(1)
+
+	>>> # display list of peers (SIP and IAX2)
+	>>> print ajam.peers())
+	>>> # display peer 101 attributes
+	>>> peer  = ajam.sippeer('101'))
+
+	>>> # screenprint events
+	>>> def ajam_event_listener(data):
+	>>>		print data
+
+	>>> ajam.waitevent(async=False, callback=ajam_event_listener)
+
+About
+-----
+
+*PyAjam* is licensed under GNU GPL v3.
+It is developped by Guillaume Bour <guillaume@bour.cc>

setup.py

@@ -1,16 +1,35 @@
+#!/usr/bin/env python
+# -*- coding: utf8 -*-
+__version__ = "$Revision$ $Date$"
+__author__  = "Guillaume Bour <guillaume@bour.cc>"
+__license__ = """
+	Copyright (C) 2009-2011, Guillaume Bour <guillaume@bour.cc>
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU General Public License as
+	published by the Free Software Foundation, version 3.
+
+	This program is distributed in the hope that it will be useful,
+	but WITHOUT ANY WARRANTY; without even the implied warranty of
+	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+	GNU Affero General Public License for more details.
+
+	You should have received a copy of the GNU Affero General Public License
+	along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
 from setuptools import setup, find_packages
 
 
 setup(
-	name 							= "Pyajam",
-	version 					= "0.1",
-	packages 					= find_packages(),
-	install_requires 	= ["4Suite-XML >= 1.0.2"],
+	name              = "Pyajam",
+	version           = "0.1.1",
+	packages          = find_packages(),
+	install_requires  = ["4Suite-XML >= 1.0.2"],
 
-	author 						= "Guillaume Bour",
-	author_email 			= "guillaume@bour.cc",
-	description 			= "blablabla",
-	license 					= "GPL3",
-	keywords 					= "asterisk ajam api",
-	url 							= "http://devedge.bour.cc/wiki/Pyajam",
+	author            = "Guillaume Bour",
+	author_email      = "guillaume@bour.cc",
+	description       = "blablabla",
+	license           = "GPL3",
+	keywords          = "asterisk ajam api",
+	url               = "http://devedge.bour.cc/wiki/Pyajam",
 )