Permalink
Browse files

Added short README

  • Loading branch information...
1 parent 3c8f0cd commit 6f9d380f9e9a44651a6453d12540b86fd2833f07 @giorgiosironi committed May 10, 2011
Showing with 19 additions and 0 deletions.
  1. +19 −0 README.txt
View
@@ -0,0 +1,19 @@
+PUG (PHP UML Generator) is a tool which generates an Uml class diagram from a live PHP object graph.
+Up to now, it generates code for the yUML tool (yuml.me), not directly pictures.
+
+- Usage
+<?php
+require_once 'tests/bootstrap.php';
+
+class SampleTest extends PHPUnit_Framework_TestCase
+{
+ public function testGenerationOfyUMLCode()
+ {
+ $introspector = new UmlReflector\Introspector;
+ $directives = new UmlReflector\Directives;
+ $object = new stdClass; // substitute with your root object
+ $introspector->visualize($object, $directives);
+ // code for yUML
+ var_dump($directives->toString());
+ }
+}

0 comments on commit 6f9d380

Please sign in to comment.