Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add a LICENSE and a README outlining the thinking behind this library

  • Loading branch information...
commit c02dfc5e2360da337a7b625264abb80b585673e3 1 parent d161230
Ben Langfeld benlangfeld authored
Showing with 43 additions and 0 deletions.
  1. +20 −0 LICENSE.txt
  2. +23 −0 README.md
20 LICENSE.txt
View
@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ben Langfeld, Jay Phillips
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 README.md
View
@@ -0,0 +1,23 @@
+# RubyAMI
+RubyAMI is an AMI client library in Ruby and based on EventMachine with the sole purpose of providing an connection to the Asterisk Manager Interface. RubyAMI does not provide any features beyond connection management and protocol parsing. Actions are sent over the wire, and responses come back via callbacks. It's up to you to match these up into something useful. In this regard, RubyAMI is very similar to [Blather](https://github.com/sprsquish/blather) for XMPP or Punchblock, the Ruby 3PCC library. In fact, Punchblock uses RubyAMI under the covers for its Asterisk implementation.
+
+## Installation
+ gem install ruby_ami
+
+## Links:
+* [Source](https://github.com/adhearsion/ruby_ami)
+* [Documentation](http://rdoc.info/github/adhearsion/ruby_ami/master/frames)
+* [Bug Tracker](https://github.com/adhearsion/ruby_ami/issues)
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+ * If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2011 Ben Langfeld, Jay Phillips. MIT licence (see LICENSE for details).
Please sign in to comment.
Something went wrong with that request. Please try again.