Minor cleanups for initial release

CHANGELOG.md

@@ -1,7 +1,10 @@
 # Change Log
 
 ## [Unreleased][unreleased]
+
+## [0.1.0][0.1.0]
 ### Added
 - Initial version
 
 [unreleased]: https://github.com/stevewest/changelog
+[0.1.0]: https://github.com/stevewest/changelog/releases/tag/0.1.0

README.md

@@ -1,5 +1,4 @@
-ChangeLog
-=========
+# ChangeLog
 
 ![Travis Build](https://img.shields.io/travis/stevewest/changelog.svg?style=flat-square)
 ![Code Coverage](https://img.shields.io/scrutinizer/g/stevewest/changelog.svg?style=flat-square)
@@ -13,5 +12,25 @@ able to convert those to an object structure to allow them to be modified easily
 then written out to a configured output. The output could be to a file on disk or
 committed to a git repo.
 
-Everything will be "driver" based so multiple sources, parsers and outputs can be
-used as desired.
+Everything is adaptor/driver based so multiple sources, parsers and outputs can be
+used as desired. There are also plans for a cli script.
+
+## Example
+
+```php
+<?php
+
+$provider = new \ChangeLog\Provider\File([
+	'file' => 'path/to/changelog.md'
+]);
+
+$parser = new \ChangeLog\Parser\KeepAChangeLog();
+
+$log = (new \ChangeLog\ChangeLog(
+	$provider,
+	$parser
+));
+
+// Instance of ChangeLog\Log
+var_dump($log);
+```

src/AbstractProvider.php

@@ -28,10 +28,18 @@ abstract class AbstractProvider implements ProviderInterface
 	 */
 	protected $configDefaults = [];
 
+	/**
+	 * @param array $config
+	 */
+	public function __construct($config = [])
+	{
+		$this->setConfig($config);
+	}
+
 	/**
 	 * {@inheritdoc}
 	 */
-	public function setConfig(array $config)
+	public function setConfig($config)
 	{
 		$this->config = $config;
 	}
@@ -42,7 +50,7 @@ public function setConfig(array $config)
 	 *
 	 * @param string|int $key
 	 *
-	 * @return string
+	 * @return string|array
 	 */
 	public function getConfig($key = null)
 	{

src/ChangeLog.php

@@ -17,11 +17,33 @@ class ChangeLog
 {
 
 	/**
-	 * @return bool
+	 * @var ParserInterface
 	 */
-	public function returnTrue()
+	protected $parser;
+
+	/**
+	 * @var ProviderInterface
+	 */
+	protected $provider;
+
+	/**
+	 * @param ProviderInterface $provider
+	 * @param ParserInterface   $parser
+	 */
+	public function __construct(ProviderInterface $provider, ParserInterface $parser)
+	{
+		$this->provider = $provider;
+		$this->parser = $parser;
+	}
+
+	/**
+	 * @return Log
+	 */
+	public function parse()
 	{
-		return true;
+		return $this->parser->parse(
+			$this->provider->getContent()
+		);
 	}
 
 }

src/ProviderInterface.php

@@ -24,7 +24,7 @@ interface ProviderInterface
 	 *
 	 * @return void
 	 */
-	public function setConfig(array $config);
+	public function setConfig($config);
 
 	/**
 	 * Returns the content of the change log to be parsed.