Skip to content

Commit a1aeaa3

Browse files
committed
docs: update README
1 parent 55f7a18 commit a1aeaa3

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Robust Redis-backed background job processing for WordPress. Provides prioritized, delayed, and retryable jobs with an admin UI, REST API, token-based auth (scopes + rate limiting), and extensibility for custom job types.
44

5+
The idea is to give inspiration to build production-ready queue systems in WordPress, following best practices and patterns.
6+
57
## Feature Highlights
68

79
Core:
@@ -123,15 +125,21 @@ composer require predis/predis
123125

124126
### Plugin Installation
125127

126-
1. **Download/Clone** this plugin to your WordPress plugins directory:
127-
```bash
128-
cd wp-content/plugins/
129-
git clone https://github.com/soderlind/redis-queue-demo.git
130-
```
131128

132-
2. **Activate** the plugin through the WordPress admin interface
129+
- **Quick Install**
130+
131+
- Download [`redis-queue-demo.zip`](https://github.com/soderlind/redis-queue-demo/releases/latest/download/redis-queue-demo.zip)
132+
- Upload via Plugins > Add New > Upload Plugin
133+
- Activate the plugin.
134+
135+
- **Composer Install**
136+
137+
```bash
138+
composer require soderlind/redis-queue-demo
139+
```
133140

134-
3. **Configure Redis** settings in the plugin settings page
141+
- **Updates**
142+
* Plugin [updates are handled automatically](https://github.com/soderlind/wordpress-plugin-github-updater#readme) via GitHub. No need to manually download and install updates.
135143

136144
## Configuration
137145

0 commit comments

Comments
 (0)