Skip to content

Commit

Permalink
readme and case renaming
Browse files Browse the repository at this point in the history
  • Loading branch information
raveren committed May 17, 2012
1 parent b83605c commit 11b726f
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 792 deletions.
40 changes: 21 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Kint - debugging helper for PHP developers

Kint for PHP is a **zero-setup replacement** for **[var_dump()](http://php.net/manual/en/function.var-dump.php)**, **[print_r()](http://php.net/manual/en/function.print-r.php)** and **[debug_backtrace()](http://php.net/manual/en/function.debug-backtrace.php)**. Extremely easy to use but easy on the eyes, powerful and customizable.
Kint for PHP is a **zero-setup replacement** for **[var_dump()](http://php.net/manual/en/function.var-dump.php)**, **[print_r()](http://php.net/manual/en/function.print-r.php)** and **[debug_backtrace()](http://php.net/manual/en/function.debug-backtrace.php)**. Extremely easy to use but powerful and customizable.

Kint is an ideological successor _(and a superior alternative)_ to Krumo, which you may know as "**Var_dump 2.0**".

Expand All @@ -14,36 +14,38 @@ Kint is an ideological successor _(and a superior alternative)_ to Krumo, which
* Handles recursive variables.
* Much more information is displayed about the variable in many cases:
- static properties of the dumped objects class;
- specific types of data is recognized and displayed in a custom way (eg. JSON strings);
- specific types of data are recognized and displayed in a custom way (eg. JSON, XML strings);
- if a resource variable is of an opened file, the file name is displayed and much more...
* Complex variables are dumped with a fixed nested depth so that it doesn't hang up your browser for enormous objects. This can be turned off on the fly - read on.
* Ability to automatically call `ob_clean()` before outputting, in most cases this means the dump comes at the top of the page, not obstructed by page elements.
* Kint can display *or return* its output, the output itself is formatted via HTML5/CSS3 or whitespace in plain text.
* Ability to dynamically turn off any output so you can debug live systems without users knowing.
* Modifiers to alter the output *(100% unique feature)* - see below.
* Much shorter name - `d($var)` (it's an alias for `Kint::dump`). See below for complete usage.
* Modifiers to alter functionality on the fly *(100% unique feature)* - see below.
* Much shorter name - `d($var)` (it's an alias for `Kint::dump()`). See below for complete usage.

## Installation and usage

<?php
require '/kint/Kint.class.php';
<?php
require '/kint/Kint.class.php';

Kint::dump($_SERVER);
// or
d($_GOBALS);
// for trace:
Kint::trace();
Kint::dump($_SERVER);
// or
d($_GOBALS);
// for trace:
Kint::trace();

See [the wiki](https://github.com/raveren/kint/wiki) for more, but above is enough to get started.


[See the wiki](https://github.com/raveren/kint/wiki) for more documentation on configuration, credits and tips&tricks.

## Version history

For full changelog [see here](https://github.com/raveren/kint/wiki/Changelog).

v1.0
* Refactored most of the code from scratch.
**v1.0 2012-05-17**
* Heavily refactored most of the code.
* Tabular data is now optionally showed in a table layout.
* Custom data parsers are supported, JSON and SplFileInfo are included in this version, more will follow.
* When dumping `get_defined_vars()` results are displayed as separate variables, which they are, not an array. Same functionality can be achieved if dumping a variable named `$_kint_flatten`.
* Custom data parsers are supported, JSON, XML and SplFileInfo are included in this version, more will follow.
* When dumping `get_defined_vars()` results are displayed as separate variables (which they are), not an array. Same functionality can be achieved if dumping a variable named `$_kint_flatten`.
* `s()` and `sd()` is now also a wrapper to `Kint::dump()` so can use the modifiers and other advanced features.
* Migrated to gitHub

Expand All @@ -53,13 +55,13 @@ v1.0

This tool is used heavily in real life development by the developer and constantly improved, just not committed as often. Issues and feature requests are [very welcome](https://github.com/raveren/kint/issues) and will be fixed/implemented as soon as possible.

Avoid using this tool in non-development servers, I cannot be held responsible for the performance, security and stability issues Kint may cause.
Avoid using this tool in non-development servers, I cannot be held responsible for the performance, security and stability issues Kint may cause. No license attached: use however you wish, I'd just be grateful for a backlink and feedback is always appreciated.

For integration plugins to frameworks and other systems [see here](https://github.com/raveren/kint/wiki/Kint-used-elsewhere).

### Author

**Rokas �leinius** (<a href="http://careers.stackoverflow.com/rokas-sleinius" title="Rokas �leinius CV">CV</a>)
**Rokas Šleinius** (<a href="http://careers.stackoverflow.com/rokas-sleinius" title="Rokas Šleinius CV">CV</a>)

![](http://img199.yfrog.com/img199/4323/imageda.png)

Expand Down
Loading

0 comments on commit 11b726f

Please sign in to comment.