From 5b316103d7f196ea24942917272ccaddde761a2f Mon Sep 17 00:00:00 2001 From: Simon Frings Date: Tue, 8 Dec 2020 13:32:20 +0100 Subject: [PATCH] Prepare v2.1.0 release --- .github/FUNDING.yml | 2 ++ CHANGELOG.md | 5 +++++ README.md | 33 ++++++++++++++++++++++++--------- composer.json | 2 +- 4 files changed, 32 insertions(+), 10 deletions(-) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..9c09fb8 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +github: clue +custom: https://clue.engineering/support diff --git a/CHANGELOG.md b/CHANGELOG.md index fe1da30..608df09 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Changelog +## 2.1.0 (2020-12-08) + +* Improve test suite and add .gitattributes to exclude dev files from exports. Add PHP 8 support, + update to PHPUnit 9 and simplify test setup.(#12 by @clue and #13 and #14 by @SimonFrings) + ## 2.0.0 (2016-12-18) * Feature / BC break: Support interpreting hex and octal escape sequences diff --git a/README.md b/README.md index 0a6d18f..44d1318 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# clue/arguments +# clue/php-arguments [![CI status](https://github.com/clue/php-arguments/workflows/CI/badge.svg)](https://github.com/clue/php-arguments/actions) @@ -16,6 +16,7 @@ But many other tools may need similar parsing during their runtime. **Table of contents** +* [Support us](#support-us) * [Quickstart example](#quickstart-example) * [Usage](#usage) * [split()](#split) @@ -25,6 +26,16 @@ But many other tools may need similar parsing during their runtime. * [License](#license) * [More](#more) +## Support us + +We invest a lot of time developing, maintaining and updating our awesome +open-source projects. You can help us sustain this high-quality of our work by +[becoming a sponsor on GitHub](https://github.com/sponsors/clue). Sponsors get +numerous benefits in return, see our [sponsoring page](https://github.com/sponsors/clue) +for details. + +Let's take these projects to the next level together! 🚀 + ### Quickstart example The following example code demonstrates how this library can be used to build @@ -182,7 +193,7 @@ The `UnclosedQuotesException` will be raised by the [`split()`](#split) function when the input line has unbalanced quotes (i.e. a quoted argument started without passing ending quotes). -This class extends PHP's [`InvalidArgumentException`](http://php.net/manual/en/class.invalidargumentexception.php). +This class extends PHP's [`InvalidArgumentException`](https://www.php.net/manual/en/class.invalidargumentexception.php). The `getQuotes(): string` method can be used to get the quotes this argument started with: @@ -222,13 +233,14 @@ assert($line[$pos] === $e->getQuotes()); ## Install -The recommended way to install this library is [through Composer](http://getcomposer.org). -[New to Composer?](http://getcomposer.org/doc/00-intro.md) +The recommended way to install this library is [through Composer](https://getcomposer.org/). +[New to Composer?](https://getcomposer.org/doc/00-intro.md) +This project follows [SemVer](https://semver.org/). This will install the latest supported version: ```bash -$ composer require clue/arguments:^2.0 +$ composer require clue/arguments:^2.1 ``` See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades. @@ -241,7 +253,7 @@ It's *highly recommended to use PHP 7+* for this project. ## Tests To run the test suite, you first need to clone this repo and then install all -dependencies [through Composer](http://getcomposer.org): +dependencies [through Composer](https://getcomposer.org): ```bash $ composer install @@ -255,13 +267,16 @@ $ php vendor/bin/phpunit ## License -MIT +This project is released under the permissive [MIT license](LICENSE). + +> Did you know that I offer custom development services and issuing invoices for + sponsorships of releases and for contributions? Contact me (@clue) for details. ## More * If you want to register/route available commands and their arguments, you may - want to look into using [clue/commander](https://github.com/clue/php-commander). + want to look into using [clue/php-commander](https://github.com/clue/php-commander). * If you want to build an interactive CLI tool, you may want to look into using - [clue/stdio-react](https://github.com/clue/php-stdio-react) in order to react + [clue/reactphp-stdio](https://github.com/clue/reactphp-stdio) in order to react to commands from STDIN. diff --git a/composer.json b/composer.json index cecadbc..1588651 100644 --- a/composer.json +++ b/composer.json @@ -7,7 +7,7 @@ "authors": [ { "name": "Christian Lück", - "email": "christian@lueck.tv" + "email": "christian@clue.engineering" } ], "require": {