Skip to content

Commit

Permalink
Merge pull request #169 from creative-commoners/pulls/6.0/cms5-readme
Browse files Browse the repository at this point in the history
DOC Update README.md for CMS 5
  • Loading branch information
sabina-talipova authored Apr 24, 2023
2 parents 7e280a5 + 402596a commit 8555524
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
[![CI](https://github.com/silverstripe/silverstripe-staticpublishqueue/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-staticpublishqueue/actions/workflows/ci.yml)
[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)

## Installation

```sh
composer require silverstripe/staticpublishqueue
```

## Brief

This module provides an API for your project to be able to generate a static cache of your pages to enhance
Expand All @@ -12,14 +18,6 @@ It generates the cache files using the [QueuedJobs module](https://github.com/sy

[Docs](docs/en/index.md)

## Requirements

* "silverstripe/framework": "^5",
* "silverstripe/cms": "^5",
* "silverstripe/config": "^2",
* "symbiote/silverstripe-queuedjobs": "^5",
* "silverstripe/versioned": "^2"

## Unit-testing with StaticPublisherState to disable queuedjobs for unit-tests

You can use `StaticPublisherState` to disable queuejobs job queueing and logging in unit-testing to improve performance.
Expand Down

0 comments on commit 8555524

Please sign in to comment.