Merge pull request #3 from alex-patterson-webdev/feature/1.0.0

feature/1.0.0

Author: alex-patterson-webdev

README.md

@@ -1,5 +1,6 @@
 [![Build Status](https://travis-ci.com/alex-patterson-webdev/date-time.svg?branch=master)](https://travis-ci.com/alex-patterson-webdev/date-time)
 [![codecov](https://codecov.io/gh/alex-patterson-webdev/date-time/branch/master/graph/badge.svg)](https://codecov.io/gh/alex-patterson-webdev/date-time)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/alex-patterson-webdev/date-time/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/alex-patterson-webdev/date-time/?branch=master)
 
 # About
 
@@ -10,4 +11,18 @@ are useful for the creation and manipulation of Date and Time objects in PHP.
 
 Installation via [composer](https://getcomposer.org).
 
-    require alex-patterson-webdev/date-time ^1
+    require alex-patterson-webdev/date-time ^1
+   
+## Components
+
+The module provides the following components
+
+- `DateTimeFactory` Provides an abstraction of the creation of `DateTime` objects.
+- `DateIntervalFactory` Provides an abstract for the creation of `DateInterval` objects.
+- `CurrentDateTimeProvider` service that exposes one `getDateTime() : \DateTime` method that will always return the current date and time.
+
+## Unit Tests
+
+Unit test using PHP Unit 8.
+
+    php vendor/bin/phpunit

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "alex-patterson-webdev/date-time",
   "version": "1.0.0",
-  "minimum-stability": "stable",
+  "minimum-stability": "dev",
   "prefer-stable": true,
   "authors": [
     {
@@ -29,11 +29,11 @@
     }
   },
   "scripts": {
-    "test": "phpunit --coverage-clover=coverage.xml"
+    "test": "php vendor/bin/phpunit --coverage-clover=coverage.xml"
   },
   "config": {
     "preferred-install": "dist",
     "optimize-autoloader": true,
     "sort-packages": true
   }
-}
+}

composer.lock

@@ -8,12 +8,12 @@
 >
     <testsuites>
         <testsuite name="DateTime">
-            <directory>./test</directory>
+            <directory>./test/phpunit</directory>
         </testsuite>
     </testsuites>
     <filter>
         <whitelist processUncoveredFilesFromWhitelist="false">
             <directory suffix=".php">src</directory>
         </whitelist>
     </filter>
-</phpunit>
+</phpunit>