Skip to content

Commit

Permalink
README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
totten committed Apr 9, 2024
1 parent a1eb770 commit 7af08ca
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@ Composer Downloads Plugin

The "Downloads" plugin allows you to download extra files (`*.zip` or `*.tar.gz`) and extract them within your package.

This is an updated version of [lastcall/composer-extra-files](https://github.com/LastCallMedia/ComposerExtraFiles/).
It adds integration tests, fixes some bugs, and makes a few other improvements. Some of the
configuration options have changed, so it has been renamed to prevent it from conflicting in real-world usage.

## Example

Suppose you publish a PHP package `foo/bar` which relies on an external artifact `examplelib-0.1.zip`. Place this configuration in the `composer.json` for `foo/bar`:
Expand All @@ -15,7 +11,7 @@ Suppose you publish a PHP package `foo/bar` which relies on an external artifact
{
"name": "foo/bar",
"require": {
"civicrm/composer-downloads-plugin": "~2.1"
"civicrm/composer-downloads-plugin": "~3 || ~4"
},
"extra": {
"downloads": {
Expand All @@ -31,6 +27,13 @@ Suppose you publish a PHP package `foo/bar` which relies on an external artifact

When a downstream user of `foo/bar` runs `composer install`, it will fetch and extract the zip file, creating `vendor/foo/bar/extern/examplelib`.

## Release History

* __v1.x__: Original release of [lastcall/composer-extra-files](https://github.com/LastCallMedia/ComposerExtraFiles/)
* __v2.x__: Fork. Add test suite. Rename to `composer-downloads-plugin` (`extra.downloads`). Improve tracking/redownload behaviors. Add more download options. Expand docs.
* __v3.x__: Add support for composer v2.
* __v4.x__: Improve PHP 8.2+. Swap gitignore parser. Drop composer v1.

## Evaluation

The primary strengths of `composer-downloads-plugin` are:
Expand Down

0 comments on commit 7af08ca

Please sign in to comment.