Skip to content

Commit fdadf10

Browse files
committed
chore: add readme file
1 parent 2ec6377 commit fdadf10

File tree

4 files changed

+58
-27
lines changed

4 files changed

+58
-27
lines changed

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Site Deployment Manager
2+
3+
A WordPress plugin that adds a deployment button to trigger static site rebuilds via webhook.
4+
5+
## Description
6+
7+
Site Deployment Manager adds a convenient deployment button to your WordPress admin panel that triggers a webhook to rebuild your static site. The plugin includes built-in logging functionality to track deployment history.
8+
9+
## Features
10+
11+
- One-click deployment trigger from WordPress admin
12+
- Configurable webhook URL
13+
- Deployment history logging
14+
- Clean, modern UI with status indicators
15+
- Secure nonce verification
16+
- Rate limiting to prevent multiple simultaneous deployments
17+
18+
## Requirements
19+
20+
- WordPress 5.0 or higher
21+
- PHP 7.2 or higher
22+
23+
## Installation
24+
25+
1. Upload the plugin files to `/wp-content/plugins/site-deployment-manager`
26+
2. Activate the plugin through the 'Plugins' screen in WordPress
27+
3. Configure your webhook URL in the plugin settings
28+
29+
## Usage
30+
31+
1. Go to WordPress admin panel
32+
2. Click on the "Deploy" menu item on the left tab.
33+
3. Configure your webhook URL in Settings
34+
4. Use the "Deploy Site" button to trigger builds
35+
5. View deployment history in the logs table
36+
37+
## Screenshots
38+
39+
1. Deployment dashboard with one-click deploy button and logs showing history and status
40+
41+
![](/public_assets/dashboard.png)
42+
43+
2. Deployment settings to configure webhook URL
44+
45+
![](/public_assets/settings.png)
46+
47+
## License
48+
49+
This project is licensed under the GPL v2 or later - see the [LICENSE](https://www.gnu.org/licenses/gpl-2.0.html) file for details.
50+
51+
## Author
52+
53+
Kibet Ishmael ([GitHub](https://github.com/kmishmael))
54+
55+
## Version History
56+
57+
### 1.0.0
58+
- Initial release

README.txt

Lines changed: 0 additions & 27 deletions
This file was deleted.

public_assets/dashboard.png

64.1 KB
Loading

public_assets/settings.png

23.6 KB
Loading

0 commit comments

Comments
 (0)