Add changelog

Author: stevleibelt

CHANGELOG.md

@@ -0,0 +1,107 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Upcoming]
+
+### To Add
+
+* Add support for lambdafunctions or move to __invoke() fully
+* Add example for [tee](https://en.wikipedia.org/wiki/Tee_(command))
+
+## [Unreleased]
+
+
+### Added
+
+* Added rector
+* Added php-cs-fixer
+
+### Changed
+
+* Changed readme history into this changelog
+* Changed codebase to PHP 8.2
+* Updated dependencies
+
+### Fixed
+
+* Fixed invalid package names
+
+### Removed
+
+## [1.1.1](https://github.com/bazzline/php_component_process_pipe/tree/1.1.1) - released at 29.07.2016
+
+### Changed
+
+* Updated dependency
+
+### Fixed
+
+* Fixed invalid example links
+
+### Removed
+
+* Removed local api
+
+## [1.1.0](https://github.com/bazzline/php_component_process_pipe/tree/1.1.0) - released at 06.03.2016
+
+### Added
+
+* Added php 7.0 to travis ci
+
+### Changed
+
+* Moved to psr-4 autoloading
+* Updated dependency
+
+### Fixed
+
+* Fixed invalid version link
+
+## [1.0.5](https://github.com/bazzline/php_component_process_pipe/tree/1.0.5) - released at 11.12.2015
+
+### Changed
+
+* Updated dependency
+
+## [1.0.4](https://github.com/bazzline/php_component_process_pipe/tree/1.0.4) - released at 18.11.2015
+
+### Changed
+
+* Updated dependency
+
+## [1.0.3](https://github.com/bazzline/php_component_process_pipe/tree/1.0.3) - released at 28.08.2015
+
+### Changed
+
+* Updated dependency
+
+## [1.0.2](https://github.com/bazzline/php_component_process_pipe/tree/1.0.2) - released at 04.07.2015
+
+### Changed
+
+* Updated dependency
+
+### Removed
+
+* Removed depenendy to phpmd
+
+## [1.0.1](https://github.com/bazzline/php_component_process_pipe/tree/1.0.1) - released at 08.02.2015
+
+### Added
+
+* Added "StopExecutionException"
+
+### Removed
+
+* Removed dependency to apigen
+
+## [1.0.0](https://github.com/bazzline/php_component_process_pipe/tree/1.0.0) - released at 12.11.2014
+
+### Added
+
+* Initial release
+

README.md

@@ -22,15 +22,17 @@ Downloads:
 
 It is also available at [openhub.net](http://www.openhub.net/p/720386).
 
-# Why?
+Changelog can be found [here](CHANGELOG.md).
+
+## Why?
 
 * separate complex operations into simpler
 * easy up unit testing for smaller processes
 * separate responsibility (data generator/transformer/validator/flow manipulator)
 * create process chains you can read in the code (separate integration code from operation code)
 * no dependencies (except you want to join the development team)
 
-# Examples
+## Examples
 
 * [no input](https://github.com/bazzline/php_component_process_pipe/blob/master/example/NoInput/run.php)
 * [input array](https://github.com/bazzline/php_component_process_pipe/blob/master/example/InputArray/run.php)
@@ -40,21 +42,21 @@ It is also available at [openhub.net](http://www.openhub.net/p/720386).
 * [input validator](https://github.com/bazzline/php_component_process_pipe/blob/master/example/InputValidator/run.php)
 * [data flow manipulator](https://github.com/bazzline/php_component_process_pipe/blob/master/example/DataFlowManipulator/run.php)
 
-# Install
+## Install
 
-## By Hand
+### By Hand
 
     mkdir -p vendor/net_bazzline/php_component_process_pipe
     cd vendor/net_bazzline/php_component_process_pipe
     git clone https://github.com/bazzline/php_component_process_pipe
 
-## With [Packagist](https://packagist.org/packages/net_bazzline/php_component_process_pipe)
+### With [Packagist](https://packagist.org/packages/net_bazzline/php_component_process_pipe)
 
     composer require net_bazzline/php_component_process_pipe:dev-master
 
-# Usage
+## Usage
 
-## By using the pipe method for multiple process
+### By using the pipe method for multiple process
 
 ```php
 use Net\Bazzline\Component\ProcessPipe\ExecutableException;
@@ -76,7 +78,7 @@ try {
     //handle pipe exception
 }
 ```
-## By using the pipe method once for each process
+### By using the pipe method once for each process
 
 ```php
 use Net\Bazzline\Component\ProcessPipe\ExecutableException;
@@ -97,7 +99,7 @@ try {
 }
 ```
 
-## By instantiation
+### By instantiation
 
 ```php
 use Net\Bazzline\Component\ProcessPipe\ExecutableException;
@@ -118,7 +120,7 @@ try {
 }
 ```
 
-## By doing all
+### By doing all
 
 ```php
 use Net\Bazzline\Component\ProcessPipe\ExecutableException;
@@ -145,52 +147,28 @@ try {
 }
 ```
 
-# API
+## API
 
 [API](http://www.bazzline.net/4fedd5481f448035b78eda04155168a08e3ee5b5/index.html) is available at [bazzline.net](http://www.bazzline.net).
 
-# History
-
-* upcomming
-    * @todo
-        * add support for lambdafunctions or move to __invoke() fully
-        * added example for [tee](https://en.wikipedia.org/wiki/Tee_(command))
-    * @done
-        * fixed invalid package names
-        * Added rector
-        * Added php-cs-fixer
-* [1.1.1](https://github.com/bazzline/php_component_process_pipe/tree/1.1.1) - released at 29.07.2016
-    * fixed invalid example links
-    * removed local api
-    * updated dependency
-* [1.1.0](https://github.com/bazzline/php_component_process_pipe/tree/1.1.0) - released at 06.03.2016
-    * added php 7.0 to travis ci
-    * fixed invalid version link
-    * moved to psr-4 autoloading
-    * updated dependency
-* [1.0.5](https://github.com/bazzline/php_component_process_pipe/tree/1.0.5) - released at 11.12.2015
-    * updated dependency
-* [1.0.4](https://github.com/bazzline/php_component_process_pipe/tree/1.0.4) - released at 18.11.2015
-    * updated dependency
-* [1.0.3](https://github.com/bazzline/php_component_process_pipe/tree/1.0.3) - released at 28.08.2015
-    * updated dependency
-* [1.0.2](https://github.com/bazzline/php_component_process_pipe/tree/1.0.2) - released at 04.07.2015
-    * removed depenendy to phpmd
-    * updated dependency
-* [1.0.1](https://github.com/bazzline/php_component_process_pipe/tree/1.0.1) - released at 08.02.2015
-    * add "StopExecutionException"
-    * removed dependency to apigen
-* [1.0.0](https://github.com/bazzline/php_component_process_pipe/tree/1.0.0) - released at 12.11.2014
-    * initial release
-
-# Links
-
-## thanks to
+## Development notes
+
+After code changes, please run:
+
+```bash
+composer check
+./vendor/bin/rector process
+./vendor/bin/php-cs-fixer fix source
+```
+
+## Links
+
+### Thanks to
 
 * [ralf westphal](http://ralfw.de/)
 * [the architects napkin](https://leanpub.com/thearchitectsnapkin-derschummelzettel)
 
-## other pipe implementations
+### Other pipe implementations
 
 * [pipes](https://github.com/vkartaviy/pipes)
 * [php-pipeline](https://github.com/JosephMoniz/php-pipeline)
@@ -200,6 +178,6 @@ try {
 * [tacone pipes](https://github.com/tacone/pipes)
 * [plumber](https://github.com/jadell/plumber)
 
-# Final Words
+## Final Words
 
 Star it if you like it :-). Add issues if you need it. Pull patches if you enjoy it. Write a blog entry if you use it. [Donate something](https://gratipay.com/~stevleibelt) if you love it :-].