Update example readme

jfcherng · jfcherng · commit 6da9215681c0 · 2020-02-29T01:33:28.000+08:00
Signed-off-by: Jack Cherng &lt;jfcherng@gmail.com&gt;
diff --git a/example/README.md b/example/README.md
@@ -5,3 +5,4 @@ In the parent folder (i.e., this project's root directory):
 1. Install dependencies with `composer upgrade`.
 1. Start PHP development server with `composer run-script server`.
 1. Visit `http://localhost:12388/demo.php` with your web browser.
+1. Change `old_file.txt`, `new_file.txt` and refresh the web page to play around.
diff --git a/example/demo.php b/example/demo.php
@@ -17,11 +17,11 @@
     <body>
         <?php
 
-        // include two sample files for comparison
-        $oldFilePath = __DIR__ . '/old_file.txt';
-        $newFilePath = __DIR__ . '/new_file.txt';
-        $oldFile = \file_get_contents($oldFilePath);
-        $newFile = \file_get_contents($newFilePath);
+        // the two sample files for comparison
+        $oldFile = __DIR__ . '/old_file.txt';
+        $newFile = __DIR__ . '/new_file.txt';
+        $oldString = \file_get_contents($oldFile);
+        $newString = \file_get_contents($newFile);
 
         // options for Diff class
         $diffOptions = [
@@ -67,8 +67,8 @@
 
         // demo the no-inline-detail diff
         $inlineResult = DiffHelper::calculate(
-            $oldFile,
-            $newFile,
+            $oldString,
+            $newString,
             'Inline',
             $diffOptions,
             ['detailLevel' => 'none'] + $rendererOptions
@@ -83,8 +83,8 @@
 
         // demo the word-level diff
         $inlineResult = DiffHelper::calculate(
-            $oldFile,
-            $newFile,
+            $oldString,
+            $newString,
             'Inline',
             $diffOptions,
             ['detailLevel' => 'line'] + $rendererOptions
@@ -99,8 +99,8 @@
 
         // demo the word-level diff
         $inlineResult = DiffHelper::calculate(
-            $oldFile,
-            $newFile,
+            $oldString,
+            $newString,
             'Inline',
             $diffOptions,
             ['detailLevel' => 'word'] + $rendererOptions
@@ -115,8 +115,8 @@
 
         // demo the character-level diff
         $inlineResult = DiffHelper::calculate(
-            $oldFile,
-            $newFile,
+            $oldString,
+            $newString,
             'Inline',
             $diffOptions,
             ['detailLevel' => 'char'] + $rendererOptions
@@ -131,8 +131,8 @@
 
         // generate a side by side diff
         $sideBySideResult = DiffHelper::calculateFiles(
-            $oldFilePath,
-            $newFilePath,
+            $oldFile,
+            $newFile,
             'SideBySide',
             $diffOptions,
             $rendererOptions
@@ -147,8 +147,8 @@
 
         // generate an inline diff
         $inlineResult = DiffHelper::calculateFiles(
-            $oldFilePath,
-            $newFilePath,
+            $oldFile,
+            $newFile,
             'Inline',
             $diffOptions,
             $rendererOptions
@@ -163,8 +163,8 @@
 
         // generate a combined diff
         $sideBySideResult = DiffHelper::calculateFiles(
-            $oldFilePath,
-            $newFilePath,
+            $oldFile,
+            $newFile,
             'Combined',
             $diffOptions,
             $rendererOptions
@@ -179,8 +179,8 @@
 
         // generate a unified diff
         $unifiedResult = DiffHelper::calculateFiles(
-            $oldFilePath,
-            $newFilePath,
+            $oldFile,
+            $newFile,
             'Unified',
             $diffOptions,
             $rendererOptions
@@ -195,8 +195,8 @@
 
         // generate a context diff
         $contextResult = DiffHelper::calculateFiles(
-            $oldFilePath,
-            $newFilePath,
+            $oldFile,
+            $newFile,
             'Context',
             $diffOptions,
             $rendererOptions
@@ -211,8 +211,8 @@
 
         // generate a JSON diff
         $jsonResult = DiffHelper::calculateFiles(
-            $oldFilePath,
-            $newFilePath,
+            $oldFile,
+            $newFile,
             'Json',
             $diffOptions,
             ['outputTagAsString' => true] + $rendererOptions
