Skip to content

Commit af5bb6a

Browse files
committed
updating doc
1 parent daca0fd commit af5bb6a

File tree

1 file changed

+11
-15
lines changed

1 file changed

+11
-15
lines changed

README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ from a developers' perspective.
1515

1616
Resources:
1717

18-
* [Complete PAGI/PAMI talk for the PHP Conference Argentina 2013](http://www.slideshare.net/mgornstein/phpconf-2013). Check the slide notes for the complete text :)
1918
* [Main Site](http://marcelog.github.com/PAGI)
19+
* [API](https://github.com/marcelog/PAGI/blob/master/doc/ApiIndex.md)
20+
* [Complete PAGI/PAMI talk for the PHP Conference Argentina 2013](http://www.slideshare.net/mgornstein/phpconf-2013). Check the slide notes for the complete text :)
2021
* [In-depth tutorial](http://marcelog.github.com/articles/pagi_tutorial_create_voip_telephony_application_for_asterisk_with_agi_and_php.html)
2122
* [An example IVR application that includes unit tests is available here](https://github.com/marcelog/Pagi-App-And-Test-Example)
22-
* [API](http://ci.marcelog.name:8080/job/PAGI/javadoc/)
2323
* [Professional Telephony Applications at hand](http://sdjournal.org/a-practical-introduction-to-functional-programming-with-php-sdj-issue-released/) The march edition of [Software Developer Journal](http://sdjournal.org/) features a complete article about writing telephony applications with PAMI and PAGI.
2424

2525
# Installing
@@ -31,13 +31,7 @@ composer.json:
3131
}
3232
```
3333

34-
# Documentation
35-
36-
* Autogenerated documentation for this source can be found in the [doc](https://github.com/marcelog/PAGI/blob/master/doc/ApiIndex.md) directory.
37-
* Some usage examples can be found in the [doc/examples](https://github.com/marcelog/PAGI/blob/master/doc/examples) directory.
38-
39-
# Included Examples
40-
Please see **docs/examples** for all the included examples.
34+
# Quickstart
4135

4236
You can start by *docs/examples/quickstart* for a very basic example. You'll need something like this in your dialplan:
4337

@@ -50,7 +44,9 @@ You can start by *docs/examples/quickstart* for a very basic example. You'll nee
5044
A mocked pagi client is included to easily test your ivr applications. See
5145
**docs/examples/mock** to see an example of how to use it.
5246

53-
# Nodes
47+
# Features
48+
49+
## Nodes
5450

5551
For a tutorial about nodes, see [this article](http://marcelog.github.com/articles/pagi_node_call_flow_easy_telephony_application_for_asterisk_php.html)
5652

@@ -79,16 +75,16 @@ callback, etc. For an example, see docs/examples/nodecontroller/example.php
7975

8076
An article about the node controller is available [here](http://marcelog.github.com/articles/making_your_ivr_nodes_call_flow_with_pagi_and_php_asterisk.html)
8177

82-
# AutoDial
78+
## AutoDial
8379

8480
CallFiles are supported. You can also schedule a call in the future.
8581

86-
# Fax
82+
## Fax
8783

8884
Sending and receiving faxes is supported using spandsp (applications SendFax
8985
and ReceiveFax).
9086

91-
# Available Facades
87+
## Available Facades
9288

9389
* PAGI\Client\CDR: Provided to access cdr variables.
9490
* PAGI\Client\ChannelVariables: Provided to access channel variables and asterisk
@@ -100,7 +96,7 @@ environment variables.
10096
* PAGI\Logger\Asterisk: Provides access to asterisk logger (see logger.conf in
10197
your asterisk installation).
10298

103-
# Results
99+
## Results
104100

105101
For every operation, a Result is provided. Some operations decorate this
106102
Result to add functionality, like PlayResult, ReadResult, etc. For example,
@@ -113,7 +109,7 @@ in turn, decorated a Result.
113109
* PAGI\Client\PlayResult
114110
* PAGI\Client\FaxResult
115111

116-
# Debugging, logging
112+
## Debugging, logging
117113

118114
You can optionally set a [PSR-3](http://www.php-fig.org/psr/psr-3/) compatible logger:
119115
```php

0 commit comments

Comments
 (0)