Documentation

Author: steevanb

README.md

@@ -1,8 +1,8 @@
-[![version](https://img.shields.io/badge/version-1.0.1-green.svg)](https://github.com/steevanb/php-backtrace/tree/1.0.1)
+[![version](https://img.shields.io/badge/version-1.1.0-green.svg)](https://github.com/steevanb/php-backtrace/tree/1.1.0)
 [![php](https://img.shields.io/badge/php->=5.4-blue.svg)](http://php.net)
-![Lines](https://img.shields.io/badge/code lines-380-green.svg)
+![Lines](https://img.shields.io/badge/code lines-680-green.svg)
 ![Total Downloads](https://poser.pugx.org/steevanb/php-backtrace/downloads)
-[![SensionLabsInsight](https://img.shields.io/badge/SensionLabsInsight-platinum-brightgreen.svg)](https://insight.sensiolabs.com/projects/2b6dd6a0-ef48-4b5b-ba13-e825e0841be3/analyses/4)
+[![SensionLabsInsight](https://img.shields.io/badge/SensionLabsInsight-platinum-brightgreen.svg)](https://insight.sensiolabs.com/projects/2b6dd6a0-ef48-4b5b-ba13-e825e0841be3/analyses/5)
 [![Scrutinizer](https://scrutinizer-ci.com/g/steevanb/php-backtrace/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/steevanb/php-backtrace/)
 
 php-backtrace
@@ -14,7 +14,7 @@ Installation
 ------------
 
 ```bash
-composer require-dev steevanb/php-backtrace ^1.0
+composer require-dev steevanb/php-backtrace ^1.1
 ```
 
 Configuration
@@ -32,10 +32,14 @@ Usage
 -----
 
 ```php
+// get backtrace dump as array
+\DumpBacktrace::getBacktraces($offset = 0, $limit = null);
+// get backtrace dump as HTML
+\DumpBacktrace::getDump($offset = 0, $limit = null);
+// write getDump() HTML with echo
 \DumpBacktrace::dump($offset = 0, $limit = null);
+// write getDump() HTML with echo, and exit
+\DumpBacktrace::eDump($offset = 0, $limit = null)
 ```
 ![PHP Backtrace](backtrace.png)
 
-```php
-\DumpBacktrace::getBacktraces($offset = 0, $limit = null);
-```