diff --git a/README.md b/README.md index e69de29..3e9e709 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,66 @@ + +``` +npx @wordpress/create-block@latest +Need to install the following packages: +@wordpress/create-block@4.64.0 +Ok to proceed? (y) + + +Let's customize your WordPress plugin with blocks: +✔ The template variant to use for this block: dynamic +✔ The block slug used for identification (also the output folder name): wp-printable-gallery +✔ The internal namespace for the block name (something unique for your products): wpprg +✔ The display title for your block: Printable Gallery +✔ The short description for your block (optional): Filtered photo galleries +✔ The dashicon to make it easier to identify your block (optional): smiley +✔ The category name to help users browse and discover your block: media +✔ Do you want to customize the WordPress plugin? No + +Creating a new WordPress plugin in the /home/vdv/wp-printable-gallery directory. + +Creating a "block.json" file. + +Creating a "package.json" file. + +Installing `@wordpress/scripts` package. It might take a couple of minutes... + +Formatting JavaScript files. + +Compiling block and generating blocks manifest. + +Done: WordPress plugin Printable Gallery bootstrapped in the /home/vdv/wp-printable-gallery directory. + +You can run several commands inside: + + $ npm start + Starts the build for development. + + $ npm run build + Builds the code for production. + + $ npm run format + Formats files. + + $ npm run lint:css + Lints CSS files. + + $ npm run lint:js + Lints JavaScript files. + + $ npm run plugin-zip + Creates a zip file for a WordPress plugin. + + $ npm run packages-update + Updates WordPress packages to the latest version. + +To enter the directory type: + + $ cd wp-printable-gallery + +You can start development with: + + $ npm start + +Code is Poetry + +```