[DebugBundle] remove README.md

This commit is contained in:
Nicolas Grekas 2014-11-07 21:20:29 +01:00
parent 50021bdeaa
commit 6258ae863b

View File

@ -1,22 +0,0 @@
dump() function
================
This bundle provides a better `dump()` function, that you can use instead of
`var_dump()`, *better* meaning:
- per object and resource types specialized view: e.g. filter out Doctrine noise
while dumping a single proxy entity, or get more insight on opened files with
`stream_get_meta_data()`. Add your own dedicated `Dumper\Caster` and get the
view *you* need.
- configurable output format: HTML, command line with colors or [a dedicated high
accuracy JSON format](Resource/doc/json-spec.md).
- ability to dump internal references, either soft ones (objects or resources)
or hard ones (`=&` on arrays or objects properties). Repeated occurrences of
the same object/array/resource won't appear again and again anymore. Moreover,
you'll be able to inspect the reference structure of your data.
- ability to operate in the context of an output buffering handler.
- full exposure of the internal mechanisms used for walking through an arbitrary
PHP data structure.
Calling `dump($myVvar)` works in all PHP code and `{% dump myVar %}` or
`{{ dump(myVar) }}` in Twig templates.