README in TemplateMethod

Dominik Liebler · Dominik Liebler · commit c5d0030f5f38 · 2013-09-24T13:03:40.000+02:00
diff --git a/TemplateMethod/Journey.php b/TemplateMethod/Journey.php
@@ -3,21 +3,7 @@
 namespace DesignPatterns\TemplateMethod;
 
 /**
- * Template Method is a behavioral design pattern.
- * 
- * Perhaps you have encountered it many times already. The idea is to let subclasses
- * of this abstract template "finish" the behavior of an algorithm.
- * 
- * A.k.a the "Hollywood principle" : "" Don't call us, we call you. ""
- * This class is not called by subclasses but the inverse.
- * How ? With abstraction of course. 
- * 
- * In other words, this is a skeleton of algorithm, well-suited for framework 
- * libraries. The user has just to implement one method and the superclass do
- * the job.
- * 
- * It is an easy way to decouple concrete classes and reduce copy-paste, 
- * that's why you'll find it everywhere.
+ *
  */
 abstract class Journey
 {
diff --git a/TemplateMethod/README.md b/TemplateMethod/README.md
@@ -0,0 +1,14 @@
+# Template Method
+
+## Purpose
+
+Template Method is a behavioral design pattern.
+
+Perhaps you have encountered it many times already. The idea is to let subclasses of this abstract template "finish" the behavior of an algorithm.
+
+A.k.a the "Hollywood principle": "Don't call us, we call you." This class is not called by subclasses but the inverse.
+How? With abstraction of course.
+
+In other words, this is a skeleton of algorithm, well-suited for framework libraries. The user has just to implement one method and the superclass do the job.
+
+It is an easy way to decouple concrete classes and reduce copy-paste, that's why you'll find it everywhere.
