Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
psorensen committed Jan 19, 2024
1 parent 337977c commit cd79a03
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ The WordPress Query Loop Block is a powerful block, enabling authors to curate b
![Curated Query Loop Demo Gif](assets/images/curated-query-loop.gif)

## Caveats
This plugin extends the core Query Loop block, and as such

1. Like the standard Query Loop block, this is limited to one post type - the post type in the curation search results will be determined by the post type selected in the Query Loop settings.
2. Posts are not backfilled - this uses the `post__in` WP_Query parameter, meaning any posts_per_page argument exceeding the number of selected posts will be ignored. Posts will be limited to the specific posts selected.
Expand All @@ -15,4 +16,6 @@ Currently, compiled assets are not included and must be manually built.
1. Clone this repository into `wp-content/plugins`
2. Install composer dependencies with `composer install`
3. Install NPM dependencies with `npm i` and build plugin using `npm run build`. Node 18+ recommended.
4. Optional - This ships with @wordpress/env installed. If you have Docker installed and running, you can simply run `npm run env:start` to spin up a local environment with the plugin activated.

## Development
5. This ships with [`@wordpress/env`](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/) installed. If you have Docker installed and running, you can simply run `npm run env:start` to spin up a local environment with the plugin activated.

0 comments on commit cd79a03

Please sign in to comment.