diff --git a/README.md b/README.md index 6fc85da..6e8ed78 100644 --- a/README.md +++ b/README.md @@ -12,14 +12,14 @@ You can install an extension using the `install` command. For example, to install the `example_pie_extension` extension, you would run: ```shell -$ bin/pie install asgrim/example-pie-extension +$ bin/pie install example/example-pie-extension This command may need elevated privileges, and may prompt you for your password. You are running PHP 8.3.10 Target PHP installation: 8.3.10 nts, on Linux/OSX/etc x86_64 (from /usr/bin/php8.3) -Found package: asgrim/example-pie-extension:1.0.1 which provides ext-example_pie_extension +Found package: example/example-pie-extension:1.0.1 which provides ext-example_pie_extension phpize complete. Configure complete. -Build complete: /tmp/pie_downloader_66e0b1de73cdb6.04069773/asgrim-example-pie-extension-769f906/modules/example_pie_extension.so +Build complete: /tmp/pie_downloader_66e0b1de73cdb6.04069773/example-example-pie-extension-769f906/modules/example_pie_extension.so Install complete: /usr/lib/php/20230831/example_pie_extension.so You must now add "extension=example_pie_extension" to your php.ini $ @@ -39,7 +39,7 @@ On Windows, you may provide a path to the `php` executable itself using the to run PIE, but we want to download the extension for PHP 8.3: ```shell -> C:\php-8.3.6\php.exe bin/pie install --with-php-path=C:\php-8.1.7\php.exe asgrim/example-pie-extension +> C:\php-8.3.6\php.exe bin/pie install --with-php-path=C:\php-8.1.7\php.exe example/example-pie-extension ``` ## Extensions that support PIE diff --git a/docs/extension-maintainers.md b/docs/extension-maintainers.md index abb8272..f7febc3 100644 --- a/docs/extension-maintainers.md +++ b/docs/extension-maintainers.md @@ -12,9 +12,11 @@ notable exceptions: * The `type` MUST be either `php-ext` for a PHP Module (this will be most extensions), or `php-ext-zend` for a Zend Extension. * An additional `php-ext` section MAY exist. - * The Composer package name (i.e. the top level `name` field) for a PIE - extension cannot share the same Composer package name as a regular PHP - package, even if they have different `type` fields. + * The Composer package name (i.e. the top level `name` field) should follow + the usual Composer package name format, i.e. `/`. + * However, please note that the Composer package name for a PIE extension + cannot share the same Composer package name as a regular PHP package, even + if they have different `type` fields. ### The `php-ext` definition @@ -36,8 +38,8 @@ given a `composer.json` with: The extension name would be derived as `myextension`. The `myvendor/` vendor prefix is removed. -The `extension-name` MAY be prefixed with `ext-` as is a convention in Composer, -but this is optional. +The `extension-name` SHOULD NOT be prefixed with `ext-` as is a convention in +Composer when using `require`. An example of `extension-name` being used: