Skip to content

Commit

Permalink
updaded README.md
Browse files Browse the repository at this point in the history
added description for new method: 'fromString'
  • Loading branch information
BelirafoN authored and BelirafoN committed Apr 22, 2016
1 parent d91fef8 commit 805430e
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Build Status](https://travis-ci.org/BelirafoN/asterisk-ami-event-utils.svg?branch=master)](https://travis-ci.org/BelirafoN/asterisk-ami-event-utils)
[![Coverage Status](https://coveralls.io/repos/BelirafoN/asterisk-ami-event-utils/badge.svg)](https://coveralls.io/r/BelirafoN/asterisk-ami-event-utils)

Some service functions for parse\stringify raw events from Asterisk AMI's socket.
Some service functions for parse\stringify raw events|responses|actions from Asterisk AMI's socket.
This library is a part of other library for work with Asterisk AMI, which will be release soon.

### NodeJS versions
Expand All @@ -21,7 +21,9 @@ like this: *[['prop_name_1', 'prop_val_1'], ..., ['prop_name_n', 'prop_val_n']]*
* **`.fromObject(eventObject)`** - converts event from object to string, which ready for send into
socket of Asterisk AMI socket;
* **`.fromArray(eventArray)`** - converts event from paired-array to string, which ready for send into
socket of Asterisk AMI socket;
socket of Asterisk AMI socket;
* **`.fromString(eventString)`** - prepares event's string into correct form for send into
socket of Asterisk AMI socket;

### Usage

Expand Down

0 comments on commit 805430e

Please sign in to comment.