From 4f8231ef40e0ccb8b26018dd631672facccd0e73 Mon Sep 17 00:00:00 2001 From: Gordon Lesti Date: Thu, 17 Oct 2019 21:48:40 +0200 Subject: [PATCH] readme changelog travis --- .travis.yml | 2 +- CHANGELOG.md | 10 ++++++++ README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++- 3 files changed, 75 insertions(+), 2 deletions(-) create mode 100644 CHANGELOG.md diff --git a/.travis.yml b/.travis.yml index 621d304..ef345b2 100644 --- a/.travis.yml +++ b/.travis.yml @@ -19,4 +19,4 @@ script: - composer test after_script: - - php vendor/bin/coveralls -v + - php vendor/bin/php-coveralls -v diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..55568fb --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,10 @@ +# Changelog + +All Notable changes to `gordonlesti/longest-common-subsequence` will be documented in this file. + +Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles. + +## 1.0.0 - 2019-10-17 + +### Added +- Created class `LongestCommonSubsequence` with static function `lcs` and tests diff --git a/README.md b/README.md index 96dbe82..0526c11 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,65 @@ # LongestCommonSubsequence -PHP Implementation of Longest common subsequence algorith + +[![Latest Version on Packagist][ico-version]][link-packagist] +[![Software License][ico-license]](LICENSE.md) +[![Build Status][ico-travis]][link-travis] +[![Coverage Status][ico-coveralls]][link-coveralls] +[![Total Downloads][ico-downloads]][link-downloads] + +PHP Implementation of Longest common subsequence algorith that works with UTF-8. + +## Install + +Via Composer + +``` bash +$ composer require gordonlesti/longest-common-subsequence +``` + +## Usage + +``` php +use GordonLesti\LongestCommonSubsequence\LongestCommonSubsequence; +``` + +With default default costs. + +``` php +$$lcsDist = LongestCommonSubsequence::lcs("DABDC", "CBDBBAC"); +``` + +## Change log + +Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. + +## Testing + +``` bash +$ composer test +``` + +## Security + +If you discover any security related issues, please email info@gordonlesti.com instead of using the issue tracker. + +## Credits + +- [Gordon Lesti][link-author] +- [All Contributors][link-contributors] + +## License + +The MIT License (MIT). Please see [License File](LICENSE) for more information. + +[ico-version]: https://img.shields.io/packagist/v/gordonlesti/longest-common-subsequence.svg?style=flat-square +[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square +[ico-travis]: https://img.shields.io/travis/GordonLesti/LongestCommonSubsequence/master.svg?style=flat-square +[ico-coveralls]: https://img.shields.io/coveralls/GordonLesti/LongestCommonSubsequence/master.svg?style=flat-square +[ico-downloads]: https://img.shields.io/packagist/dt/gordonlesti/longest-common-subsequence.svg?style=flat-square + +[link-packagist]: https://packagist.org/packages/gordonlesti/longest-common-subsequence +[link-travis]: https://travis-ci.org/GordonLesti/LongestCommonSubsequence +[link-coveralls]: https://coveralls.io/r/GordonLesti/LongestCommonSubsequence?branch=master +[link-downloads]: https://packagist.org/packages/gordonlesti/longest-common-subsequence +[link-author]: https://gordonlesti.com +[link-contributors]: ../../contributors