Skip to content

Commit f63ba42

Browse files
author
Arunas Mazeika
committed
Added readme file
1 parent c4603b1 commit f63ba42

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
joomla-catcher
2+
==============
3+
4+
Catcher is a bundle of plugins and a library for catching and debug Joomla! events.
5+
6+
## Installation
7+
8+
### Composer
9+
10+
You can install this package using [Composer](https://getcomposer.org/). Create a `composer.json` file inside the root directory of your Joomla! site containing the following code:
11+
12+
```
13+
{
14+
"require": {
15+
"nooku/pkg_catcher": "dev-master"
16+
},
17+
"minimum-stability": "dev"
18+
}
19+
```
20+
21+
Run composer install.
22+
23+
### Phing
24+
25+
For convenience, a [phing](http://www.phing.info/) script for building the package is also available under the `/scripts/build` folder of the repo.
26+
27+
After building it, the package may be installed using the Joomla! extension manager.
28+
29+
## Usage
30+
31+
After the package is installed, make sure to enable the plugins and configure them to catch and report events.

0 commit comments

Comments
 (0)