Skip to content

Commit

Permalink
docs: Add Contribution Guidelines and Support Information
Browse files Browse the repository at this point in the history
  • Loading branch information
rafaucau committed Jun 16, 2023
1 parent e392dee commit 82205bd
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# LiteSpeed Cache for Flarum


[![Latest Stable Version](https://img.shields.io/packagist/v/acpl/flarum-lscache)](https://packagist.org/packages/acpl/flarum-lscache) [![Total Downloads](https://img.shields.io/packagist/dt/acpl/flarum-lscache.svg)](https://packagist.org/packages/acpl/flarum-lscache)
[![Latest Stable Version](https://img.shields.io/packagist/v/acpl/flarum-lscache)](https://packagist.org/packages/acpl/flarum-lscache) [![Total Downloads](https://img.shields.io/packagist/dt/acpl/flarum-lscache.svg)](https://packagist.org/packages/acpl/flarum-lscache) [![GitHub Sponsors](https://img.shields.io/badge/Donate-%E2%9D%A4-%23db61a2.svg?&logo=github&logoColor=white&labelColor=181717)](https://github.com/android-com-pl/flarum-lscache?sponsor=1)

A [Flarum](http://flarum.org) extension. Integrates [LSCache](https://lscache.io/) with your forum.

Expand Down Expand Up @@ -34,6 +34,18 @@ When you clear the Flarum cache, the LSCache is also cleared automatically unles

You can clear the LSCache without clearing the Flarum cache via the admin panel. This option is available under the standard Flarum cache clearing option. There is also the `php flarum lscache:clear` command. The command supports the `--path` argument. For example, `php flarum lscache:clear --path=/tags --path=/d/1-test`. You can use this if you only want to purge specific paths instead of the entire cache.

## How to Contribute

We welcome any contributions to the development of LiteSpeed Cache for Flarum!
If you'd like to contribute, feel free to fork [this repository](https://github.com/android-com-pl/flarum-lscache) and submit a pull request.
You can also [open an issue](https://github.com/android-com-pl/flarum-lscache/issues) if you want to suggest improvements or report a problem.

### Support This Project

This project is open source and maintained by a single developer.
If you find it useful and would like to ensure its continued development, please consider supporting it through [GitHub Sponsors](https://github.com/android-com-pl/flarum-lscache?sponsor=1).
Your support is greatly appreciated!

## Links

- [Packagist](https://packagist.org/packages/acpl/flarum-lscache)
Expand Down
6 changes: 6 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
"source": "https://github.com/android-com-pl/flarum-lscache",
"forum": "https://discuss.flarum.org/d/29475-litespeed-cache-for-flarum"
},
"funding": [
{
"type": "github",
"url": "https://github.com/android-com-pl/flarum-lscache?sponsor=1"
}
],
"require": {
"flarum/core": "^1.7",
"php": ">=8.0"
Expand Down

0 comments on commit 82205bd

Please sign in to comment.