Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC Update README.md for CMS 5 #72

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 3 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,29 +13,10 @@ provides.
The bulk of the heavy lifting here is done using the Composer PHP API, which mimics the behaviour of using Composer on
the command line to install or update PHP packages.

### Requirements
## Installation

* bringyourownideas/silverstripe-maintenance ^2
* composer/composer ^2
* silverstripe/framework ^4

#### Compatibility

The 1.x release line of this module is compatible with Silverstripe ^3.2, and the 2.x release line is compatible with
Silverstripe ^4.0.

The 2.x release line of the module is compatible with composer v1, and this 3.x release line is
compatible with composer v2

### Installation

Run the following command to install this package:

```
composer require bringyourownideas/silverstripe-composer-update-checker ^2

vendor/bin/sake dev/build flush=1
vendor/bin/sake dev/tasks/UpdatePackageInfoTask
```sh
composer require bringyourownideas/silverstripe-composer-update-checker
```

## Note for private repositories
Expand Down