Skip to content

Commit

Permalink
Change readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jissereitsma committed Feb 9, 2022
1 parent b0fc3b5 commit 1a9bd8c
Showing 1 changed file with 6 additions and 31 deletions.
37 changes: 6 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,8 @@
# Magento 2 module for NextGenImages
This module adds next-gen image support to Magento 2. Please note that this is a base extension for other extensions to use. See [Yireo_Webp2](https://github.com/yireo/Yireo_Webp2) for details.
# Magento 2 integration testing helper
This module adds various utilities to aid in creating integration tests for Magento 2.

## Development
This module features some settings and info panels in the Magento Store Configuration. But the major feature is a plugin on the `Layout` that scans for HTML `<img/>` tags to convert them into `<picture/>` tags with sources for alternative image formats.

A module `Foo_Bar` could add a `etc/di.xml` file to add a new convertor (a class implementing `\Yireo\NextGenImages\Convertor\ConvertorInterface`) to the convertor listing:

```xml
<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
<type name="Yireo\NextGenImages\Convertor\ConvertorListing">
<arguments>
<argument name="convertors" xsi:type="array">
<item name="foobar" xsi:type="object">Foo\Bar\Convertor</item>
</argument>
</arguments>
</type>
</config>
```

# Roadmap
- Move CLI into separate module
- Move frontend into separate module
- Create GraphQL support
- Add more next gen image formats
- JPEG 2000
- HEIC
- AVIF
- JPEG XL
- WebP2
Parent classes:
- `\Yireo\IntegrationTestHelper\Test\Integration\AbstractTestCase`
- `\Yireo\IntegrationTestHelper\Test\Integration\GraphQlTestCase`

These classes offer some utility functions plus import various traits (see `Test/Integration/Traits/`) with PHPUnit assertions.

0 comments on commit 1a9bd8c

Please sign in to comment.