-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make the main README as simple as possible to give an overview of the project and structure the documentation.
- Loading branch information
Showing
3 changed files
with
48 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Application Integration | ||
|
||
The Mu Plugin is a Wp App Container Package and as such shall be consumed at application level. | ||
|
||
Whatever way you boot your application what you need to do is simply add the Package to the application. | ||
|
||
```php | ||
\Inpsyde\App\Bootstrap\app()->addPackage( | ||
\Inpsyde\GutenbergVersionsManager\Package::new() | ||
); | ||
``` | ||
|
||
The Package will read the current theme `config/gutenberg.php` file to retrieve the list of the compatible Gutenberg versions. | ||
|
||
Here an example of how the file looks like | ||
|
||
```php | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
return [ | ||
'versions' => [ | ||
'13.9.0', | ||
'12.8.0', | ||
'11.14.1', | ||
], | ||
]; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Development | ||
|
||
The project rely on [@wordpress/env](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/), and it contains all the necessary configuration to have the development environment up and running. | ||
|
||
Simply run `yarn wp-env:start` or `yarn wp-env:start --xdebug` and you're good to go. | ||
|
||
To stop the environment run `yarn wp-env:stop` | ||
|
||
The development configuration includes the followings within the `.development` directory at the root of the project. | ||
|
||
- A small theme which is configured to require a compatible Gutenberg version | ||
- A Mu Plugin which is configured to load the Gutenberg Version Manager Package |