Skip to content

Commit e099d4e

Browse files
committed
Updated the Readme to reflect the new Sparks layout and revised info.
1 parent 697ef6a commit e099d4e

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.markdown renamed to Readme.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,13 @@ Forensics adds a few things to the stock Profiler that should make your life as
99
- The Profiler output is now completely skinnable. If you've read the comments in the Profiler class before, this is something that the EllisLab devs have said for a while it would be nice to do. Congrats. It's done.
1010
- The output now also includes a list of all files that your CodeIgniter app includes, as well as their location (relative to your FCPATH).
1111
- Output also has the ability to log items and track memory in your project via a new console class.
12+
- Any variables sent to the view are shown in the bar.
1213

1314
The default look, and some of the additional functionality, was heavily inspired by ParticleTree's [PHP Quick Profiler](http://particletree.com/features/php-quick-profiler/).
1415

1516
## Installing
1617

17-
Installing Forensics is a breeze. Copy the files to the application/libraries and application/views folder as appropriate, and you're done. Whenever you tell CI to turn on the enable the profiler (by _$this->output->enable_profiler(true)_ ) it should appear in the top right-hand corner of your screen.
18-
19-
NOTE: If you're installing Forensics as a Spark, you must *move the profiler_template.php* file into your _application/views_ folder.
18+
Forensics is intended to be installed as a [Spark](http://getsparks.org). Please see their site for more information.
2019

2120
## Forensics Logging
2221

@@ -38,4 +37,11 @@ In order to use either of these functions, you must be sure to load the Console
3837

3938
## Other Tips
4039

41-
You can change the location of the profiler bar by changing the class of the *codeigniter-profiler* div (around line 102) of the *profiler_template* view to one of the following four locations: 'top-right', 'top-left', 'bottom-left', and 'bottom-right'.
40+
You can change the location of the profiler bar by changing the `$bar_location` variable at the top of the *profiler_template* view to one of the following locations:
41+
42+
* top-right
43+
* top-left
44+
* bottom-left
45+
* bottom-right
46+
* top
47+
* bottom

0 commit comments

Comments
 (0)