Skip to content

Commit

Permalink
Merge pull request #18 from StellateHQ/update-readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
thomasheyenbrock authored Feb 15, 2023
2 parents 0ca3ca2 + 92e9365 commit 60605e6
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ License URI: https://www.gnu.org/licenses/gpl-3.0.html

=== Stellate plugin for WordPress ===

This plugin is an addon for the popular [WPGraphQL](https://github.com/wp-graphql/wp-graphql) plugin. It helps with setting up [Stellate](https://stellate.co) in front of a WordPress GraphQL API by automatically taking care of invalidating the cache when content is updated in WordPress. If works no matter the source of the update (WordPress admin panel, GraphQL mutation, REST API, etc.). It also supports custom post types and custom taxonomies that are exposed over the GraphQL API.
This plugin is an addon for the popular [WPGraphQL](https://github.com/wp-graphql/wp-graphql) plugin. It helps set up [Stellate](https://stellate.co) in front of a WordPress GraphQL API by automatically invalidating the cache when content is updated in WordPress. It works no matter the source of the update, whether that is via the WordPress admin panel, a GraphQL mutation, the REST API, or another method. It also supports custom post types and custom taxonomies that are exposed over the GraphQL API.

This plugin only works when you already have the WPGraphQL plugin installed. After adding this plugin you'll see a new menu item named "Caching" in the "GraphQL" section of the dashboard sidebar. Here you can:
This plugin only works when you already have the WPGraphQL plugin installed. After adding this plugin, you'll see a new menu item named "Caching" in the "GraphQL" section of the dashboard sidebar. Here you can:

- Add the name of your Stellate service and a purging token (without that the plugin will effectively do nothing).
- Toggle between soft and hard purging. (Soft purging means that the cache will continue serving stale data even after the purge while the data is revalidated in the background.)
- Add the name of your Stellate service and a purging token (without that, the plugin will do nothing).
- Toggle between soft and hard purging. (Soft purging means the cache will continue serving stale data even after the purge while Stellate updates the data in the background.)
- Purge the entire Stellate cache right from the WordPress dashboard.

For more information check out our [documentation](https://docs.stellate.co/docs/graphcdn-wordpress-plugin).
For more information, check out our [documentation](https://stellate.co/docs/integrations/wordpress-plugin).

0 comments on commit 60605e6

Please sign in to comment.