Skip to content

Commit 85fa24a

Browse files
committed
tweak readme
1 parent cde1849 commit 85fa24a

1 file changed

Lines changed: 17 additions & 16 deletions

File tree

readme.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,45 +3,45 @@ PHPDebugConsole WAMP Plugin Client
33

44
Debug your PHP applications (both web and console) in realtime.
55

6-
Debug/log information is sent completely "out-of-bounds" via websockets. Since log data isn't sent in the message body or headers of your application, we can debug, any request method (including ajax and console application) without affecting the output.
6+
Debug/log information is sent completely "out-of-bounds" via websockets. Since log data isn't sent in the message body or headers of your application, we can debug any request method (including ajax and console application) without affecting the output.
77

8-
All [PHPDebugConsole](https://github.com/bkdotcom/debug) methods are supported.
8+
All [PHPDebugConsole](https://github.com/bkdotcom/PHPDebugConsole) methods are supported.
99

10-
using a combination of [PHPDebugConsole](https://github.com/bkdotcom/debug) and [WampPublisher](https://github.com/bkdotcom/wampPublisher)
10+
using a combination of [PHPDebugConsole](https://github.com/bkdotcom/PHPDebugConsole) and [WampPublisher](https://github.com/bkdotcom/WampPublisher)
1111

1212
### Overview
1313
There are 3 parts to this logging solution.
1414

15-
* This client. Think of this as an undocked (separate-windowed) browser console. But, instead of viewing javascript info, it's PHP stuff<sup>†</sup>.
16-
* The PHP application thats "publishing" log messages
15+
* This client. Think of this as an undocked (separate-windowed) browser console. Instead of viewing javascript info, it's PHP stuff<sup>†</sup>.
16+
* The PHP application thats "publishing" log messages (via [PHPDebugConsole](https://github.com/bkdotcom/PHPDebugConsole))
1717
* A WAMP (websockets protocol) router that serves as a middle man between this client and the PHP application
1818

1919
All 3 components *can* be be running on the same server/environment, or be on 3 separate servers, it doesn't matter. I imagine in most cases, this client and the router will be installed on a local dev environment... aka your laptop.
2020

21-
> † PHPDebugConsole also supports output via plain 'ol `<script>` output, ChromeLogger, & FirePHP.. This WAMP solution isn't limited by what the browser's console can do and offers all of the same formatting and features of PHPDebugConsole's HTML output without the disadvantages of being included in the output of your application (or not supported with ajax & CLI applications
21+
> † PHPDebugConsole also supports output via plain 'ol `<script>` output, ChromeLogger, & FirePHP.. This WAMP solution isn't limited by what the browser's console can do and offers all of the same formatting and features of PHPDebugConsole's HTML output without the disadvantages of being included in the output of your application (or not supported with ajax & CLI applications.
2222
2323

2424
### Installation
2525

26-
Download Composer (if not already installed) [more info](https://getcomposer.org/doc/00-intro.md#downloading-the-composer-executable)
26+
Download Composer (if not already installed) [more info](https://getcomposer.org/doc/00-intro.md#downloading-the-composer-executable)
2727
`$ curl -sS https://getcomposer.org/installer | php`
2828

2929
**create a project directory in your webroot**
3030

3131
$ mkdir debugWampClient
3232
$ cd debugWampClient
3333

34-
**Install this client**
34+
**Install this client**
3535
`$ php composer.phar require bdk/debug-wamp-client`
3636

37-
**Install a WAMP router** (if you don't already have one)
37+
**Install a WAMP router** (if you don't already have one)
3838
If you don't already have a WAMP router up and running, you might as well install a PHP-based one here in the same folder *(but again, it could be installed anywhere)*
39-
One client+router install can support many PHPDebugConsole projects
39+
One client+router install can support many PHPDebugConsole projects
4040
`$ php composer.phar require voryx/thruway`
4141

42-
**Start the WAMP router.**
43-
`$ php vendor/voryx/thruway/Examples/SimpleWsRouter.php`
44-
*(note that the router doesn't play well with x-debug.. you will likely need to disable x-debug for this process)*
42+
**Start the WAMP router.**
43+
`$ php vendor/voryx/thruway/Examples/SimpleWsRouter.php`
44+
*(note that the router doesn't play well with x-debug. You will likely need to disable x-debug for this process)*
4545

4646
**Create an `index.php` for the client**
4747

@@ -60,9 +60,10 @@ new \bdk\Debug\WampClient($debug);
6060

6161
The client should have connected to the router and is ready to receive log messages
6262

63-
**Add PHPDebugConsole to the project you wish to debug**
63+
**Add PHPDebugConsole to the project you wish to debug**
6464
`$ php composer.phar require bdk/debug`
65-
**Install a outputWamp plugin dependency**
65+
66+
**Install a outputWamp plugin dependency**
6667
`$ php composer.phar require bdk/wamp-publisher`
6768

6869
Add the OutputWamp plugin to your application
@@ -76,5 +77,5 @@ $wampPublisher = new \bdk\WampPublisher(array(
7677
'realm'=>'debug'
7778
));
7879
$outputWamp = new \bdk\Debug\OutputWamp($debug, $wampPublisher);
79-
$debug->addPlugin($outputWamp); // or $debug->setCfg('outputAs', $outputWamp); to not output as html
80+
$debug->addPlugin($outputWamp); // or $debug->setCfg('outputAs', $outputWamp); to prevent the default in-page html output
8081
```

0 commit comments

Comments
 (0)