From bd417a56d74e4c293b6c0b249cdc73615a31f80a Mon Sep 17 00:00:00 2001 From: Matthew Suhocki Date: Thu, 16 Jun 2022 15:22:19 +0000 Subject: [PATCH] Added more details to composer.json and README.md --- README.md | 13 ++++++++----- composer.json | 16 +++++++++++----- composer.lock | 6 ++++-- 3 files changed, 23 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a8ce0b8..828b268 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,18 @@ # Remove Symfony Polyfill -Removes Symfony polyfills from a composer project by replacing the ``symfony/polyfill-*`` libraries with no implementation. +This library removes Symfony polyfills from a composer project by replacing the `symfony/polyfill-*` libraries with no implementation. -To use add ``fivetwo/remove-symfony-polyfill`` to the ``requires`` or ``require-dev`` section of your project's composer.json file. +To install, add `fivetwo/remove-symfony-polyfill` to the `require` or `require-dev` section of your project's composer.json file. ```json { - "requires": { - "php": "~7.3.0", - "vendor/library-requiring-symfony-polyfill": "*", + "require": { "fivetwo/remove-symfony-polyfill": "~7.3.0" } } ``` +Alternatively, install from the command line. + +```shell +composer require "fivetwo/remove-symfony-polyfill" +``` diff --git a/composer.json b/composer.json index 18d5277..9105eb3 100644 --- a/composer.json +++ b/composer.json @@ -1,8 +1,15 @@ { "name": "fivetwo/remove-symfony-polyfill", - "type": "library", "description": "Remove Symfony polyfills", - "keywords": ["remove","symfony","polyfill"], + "type": "library", + "keywords": [ + "remove", + "replace", + "symfony", + "polyfill" + ], + "homepage": "https://github.com/fivetwo/remove-symfony-polyfill", + "readme": "README.md", "license": "MIT", "authors": [ { @@ -10,8 +17,8 @@ "email": "matt@fivetwo.org" } ], - "required": { - "php": ">=7.3" + "require": { + "php": ">=7.3" }, "replace": { "symfony/polyfill-apcu": "*", @@ -30,4 +37,3 @@ "symfony/polyfill-xml": "*" } } - diff --git a/composer.lock b/composer.lock index 70e5fe5..acbef2d 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "1516e1db430fd140814220fb1f269890", + "content-hash": "56174caa07581afa3ee2a0257ed9d6b2", "packages": [], "packages-dev": [], "aliases": [], @@ -12,7 +12,9 @@ "stability-flags": [], "prefer-stable": false, "prefer-lowest": false, - "platform": [], + "platform": { + "php": ">=7.3" + }, "platform-dev": [], "plugin-api-version": "2.3.0" }