Syntax highlighting in README.md

Author: Ayesh

README.md

@@ -20,61 +20,66 @@ This class is similar to phpunit/php-timer, but not a fork, nor mimic its functi
 
 ## Installing
 The simplest way would be to install using [composer](https://getcomposer.org). 
-
+```bash
     composer require ayesh/php-timer
+```
 
 If, for some reason you can't use Composer, or don't want to (oh come on!), you can integrate the class with your current `PSR-4` autoloader by mapping `Ayesh\PHP_TIMER` namespace to the repository's `src` folder. 
 
 ## Usage
 It is pretty simple to use the timer, with all methods being static, and allowing only 4 methods. 
 
 #### Start timer
-
+```php
+    <?php
     use Ayesh\PHP_Timer\Timer;
     Timer::start();
+````
 This starts the timer (actually keeps the current time stored) with the key `default`. Throughout the library, if you do not provide a specific key, this default key is used. 
 
 Alternately, you can start the timer with a given key:
-
+```php
     Timer::start('something');
+```
 Once you start the time with a given key, you can use the same key to refer to that particular timer. 
 You can of course use PHP magic constants to make things easier:
-
+```php
     Timer::start(__FUNCTION__);
+```
 Attempting to start the timer with a non-string key will throw a `\TypeError` exception. 
 You can call the `start` method multiple times even if the timer has started. It will not reset the timer.
 
 #### Read timer
 After starting the timer, you can read the elapsed time at any time. Reading the time will not stop the timer. You can read the timer, do some expensive calculations, and read again to get the cumulative time. 
-
+```php
     Timer::read(); // Default timer. 
     Timer::read('default'); // Default timer. 
     Timer::read('something'); // Timer started with key "something".
+```
 Attempting to read a timer that is not started will throw an `\LogicException` exception. 
 
 ##### Formats
 You can pass a second argument to let this library make minimal processing for you:
-
-    Timer::read('something', Timer::FORMAT_PRECISE);
-    // 0.10180473327637
-
+```php
+    Timer::read('something', Timer::FORMAT_PRECISE); // 0.10180473327637
+```
 See the formats section below for the formats supported.
 #### Stop timer
 You can stop the timer anytime as well. This makes the library store the stop time, and your further `Timer::read()` calls will always return the time it took between start and stop. 
-
+```php
     Timer::stop(); // Default timer. 
     Timer::stop('something'); // Timer started with key "something"
-
+```
 Attempting to stop a timer that is not started will throw an `\LogicException` exception. 
 
 #### Reset timer
 By default, starting the timer after stopping it will continue it from where it left off. For example, if you have 3 seconds on the timer when you stop it, and start it again, the total time will start from 3 seconds. You can explicitly reset the timer to make it start from 0. 
 Resetting the timer will not make the timer start again. You need to explicitly start the timer again with a `Timer::start()` call. 
-
+```php
     Timer::reset(); // Default timer. 
     Timer::reset('something'); 
     Timer::resetAll(); // Resets all timers.
-
+```
 ## Formats
 Currently, the following formats are provided:
 
@@ -85,16 +90,18 @@ Currently, the following formats are provided:
 ## Examples
 
 #### Calculate the timer one-off:
-
+```php
+    <?php
     use Ayesh\PHP_Timer\Timer;
 
     Timer::start();
     // do your processing here.
     $time = Timer::read('default', Timer::FORMAT_SECONDS);
     echo "Script took {$time} second(s)";
-
+````
 #### Stop watch functionality, with stop-and-go timer calculated separately.
-
+```php
+    <?php
     use Ayesh\PHP_Timer\Timer;
 
     Timer::start('full');
@@ -112,7 +119,7 @@ Currently, the following formats are provided:
     echo Timer::read('full', Timer::FORMAT_SECONDS); // 4 seconds.
     echo "<br />";
     echo Timer::read('laps', Timer::FORMAT_SECONDS); // 2 seconds (1 + 1)
-
+````
 ## Development and tests
 All issues are PRs are welcome. Travis CI and PHPUnit tests are included. If you are adding new features, please make sure to add the test coverage.
 

src/Timer.php

@@ -6,7 +6,7 @@
 /**
  * Class Timer
  *
- * Helper class to measure the execusion time between two points in a single
+ * Helper class to measure the execution time between two points in a single
  * request.
  *
  * @package Ayesh\PHP_Timer
@@ -76,7 +76,7 @@ public static function resetAll() {
   }
 
   /**
-   * Pocesses the internal timer state to return the time elapsed.
+   * Processes the internal timer state to return the time elapsed.
    * @param $value
    * @param $format
    * @return mixed
@@ -135,7 +135,10 @@ public static function read(string $key = 'default', $format = self::FORMAT_MILL
 
   /**
    * Stops the timer with the given key. Default key is "default"
+   *
    * @param string $key
+   *
+   * @throws \LogicException If the attempted timer has not started already.
    */
   public static function stop($key = 'default') {
     if (isset(self::$timers[$key])) {

tests/TimerTest.php

@@ -77,7 +77,7 @@ public function testMultipleStartsQueued() {
     $this->assertGreaterThan($timer_1 + $timer_2, $timer_3);
   }
 
-  public function testMultpleStartCallsQueued_2() {
+  public function testMultipleStartCallsQueued_2() {
     $key = 'foo';
     Timer::start($key);
     $this->assertLessThan(500, Timer::read($key));