Skip to content

Commit

Permalink
Adding readme updates / logo.
Browse files Browse the repository at this point in the history
  • Loading branch information
rdegges committed Mar 29, 2015
1 parent 5bb2eb4 commit 5331ff6
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 2 deletions.
39 changes: 37 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,44 @@
pyst2: A Python Interface to Asterisk
=====================================

.. image:: https://img.shields.io/pypi/v/pyst2.svg
:alt: pyst2 Release
:target: https://pypi.python.org/pypi/pyst2

.. image:: https://img.shields.io/pypi/dm/pyst2.svg
:alt: pyst2 Downloads
:target: https://pypi.python.org/pypi/pyst2

.. image:: https://img.shields.io/travis/rdegges/pyst2.svg
:alt: pyst2 Build
:target: https://travis-ci.org/rdegges/pyst2

.. image:: https://github.com/rdegges/pyst2/raw/master/assets/snake-sketch.jpg
:alt: Snake Sketch


Meta
----

- Author: Randall Degges
- Email: [email protected]
- Site: http://www.rdegges.com
- Status: *looking for maintainer*, active

**NOTE**: This project is in need of an active maintainer. I'm quite busy with
other non-asterisk related projects in my personal time, so if you're a good
Python programmer, and working with this library and Asterisk on a daily basis
-- please consider maintaining the project! Contact me for more information:
[email protected]

Pyst2 consists of a set of interfaces and libraries to allow programming of
In the meantime, I'm happy to accept pull requests and cut releases as needed.
If you want to contribute to the project, please do!


Purpose
-------

pyst2 consists of a set of interfaces and libraries to allow programming of
Asterisk from python. The library currently supports AGI, AMI, and the parsing
of Asterisk configuration files. The library also includes debugging facilities
for AGI.
Expand All @@ -27,10 +58,14 @@ fork, please contact me: [email protected], so we can get that setup!
Installation
------------

To install ``pyst2``, just use pip!
To install ``pyst2``, simply run:

.. code-block:: console
$ pip install pyst2
This will install the latest version of the library automatically.


Documentation
-------------
Expand Down
Binary file added assets/snake-sketch.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5331ff6

Please sign in to comment.