From 1cfc4ef4cb16dca2a5c4174f91e792212bbd661a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Dra=CC=81bek?= Date: Wed, 2 Mar 2016 16:45:16 +0100 Subject: [PATCH] Fix README to correspond with current state --- README.md | 31 ++++++++++++++++++++++--------- 1 file changed, 22 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9b45f07..ed4623e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -Git Version Panel -====================== +# Git Version Panel Panel for Tracy debug panel. Shows current branch and current revision hash to be able identify your deployed version on sight. @@ -8,8 +7,7 @@ Inspired by https://gist.github.com/vvondra/3645108. ![](http://oi59.tinypic.com/34oviv9.jpg) -Installing ----------- +## Installing Install library via composer: @@ -17,13 +15,28 @@ Install library via composer: composer require jandrabek/tracy-gitversion-panel ``` -Register panel + +## Registerring... + +### In older versions of Nette (< 2.2) ``` nette: debugger: - bar: [JanDrabek\Tracy\GitVersionPanel] -# Or when you register multiple extensions -# bar: -# - JanDrabek\Tracy\GitVersionPanel + bar: + - JanDrabek\Tracy\GitVersionPanel +``` + +### In newer versions of Nette (>= 2.2) + +``` +tracy: + bar: + - JanDrabek\Tracy\GitVersionPanel +``` + +### In pure Tracy + ``` +Tracy\Debugger::getBar()->addPanel(new JanDrabek\Tracy\GitVersionPanel()); +``` \ No newline at end of file