Add detailed Dashboard and Reports documentation to README (v0.8.0)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
76
README.md
76
README.md
@@ -19,6 +19,8 @@ WP BnB Management enables WordPress to act as a full management system for B&B h
|
|||||||
- **Auto-Updates**: Automatic update checks and installation from license server
|
- **Auto-Updates**: Automatic update checks and installation from license server
|
||||||
- **Development Mode**: License bypass for local development environments
|
- **Development Mode**: License bypass for local development environments
|
||||||
- **Contact Form 7 Integration**: Accept booking requests and inquiries through CF7 forms
|
- **Contact Form 7 Integration**: Accept booking requests and inquiries through CF7 forms
|
||||||
|
- **Dashboard**: Comprehensive admin dashboard with statistics and charts
|
||||||
|
- **Reports**: Detailed reports with CSV and PDF export
|
||||||
|
|
||||||
### Requirements
|
### Requirements
|
||||||
|
|
||||||
@@ -98,6 +100,80 @@ The plugin automatically detects local development environments and bypasses lic
|
|||||||
2. View guest records and booking history
|
2. View guest records and booking history
|
||||||
3. Manage guest information
|
3. Manage guest information
|
||||||
|
|
||||||
|
### Dashboard
|
||||||
|
|
||||||
|
The dashboard (**WP BnB → Dashboard**) provides an at-a-glance overview of your B&B operations:
|
||||||
|
|
||||||
|
**Statistics Cards:**
|
||||||
|
|
||||||
|
- **Occupancy Rate** - Current percentage of rooms occupied with trend indicator
|
||||||
|
- **Monthly Revenue** - This month's revenue with comparison to previous month
|
||||||
|
- **Total Bookings** - Active bookings count with status breakdown
|
||||||
|
- **Total Guests** - Guest count with new guests this month
|
||||||
|
|
||||||
|
**Today's Activity:**
|
||||||
|
|
||||||
|
- Check-ins scheduled for today with guest names and room assignments
|
||||||
|
- Check-outs scheduled for today
|
||||||
|
- Quick links to manage each booking
|
||||||
|
|
||||||
|
**Upcoming Bookings:**
|
||||||
|
|
||||||
|
- Next 7 days of arrivals
|
||||||
|
- Guest name, room, dates, and booking status
|
||||||
|
- Direct links to booking details
|
||||||
|
|
||||||
|
**Quick Actions:**
|
||||||
|
|
||||||
|
- New Booking - Create a booking directly
|
||||||
|
- New Guest - Add a guest record
|
||||||
|
- View Calendar - Open the availability calendar
|
||||||
|
- View Reports - Access detailed reports
|
||||||
|
|
||||||
|
**Trend Charts:**
|
||||||
|
|
||||||
|
- 30-day occupancy trend line chart
|
||||||
|
- 6-month revenue bar chart
|
||||||
|
|
||||||
|
### Reports
|
||||||
|
|
||||||
|
Access detailed reports at **WP BnB → Reports**. All reports support date range filtering and export.
|
||||||
|
|
||||||
|
**Occupancy Report:**
|
||||||
|
|
||||||
|
- Overall occupancy percentage for the selected period
|
||||||
|
- Breakdown by room showing nights booked, available, and occupancy rate
|
||||||
|
- Visual progress bars for easy comparison
|
||||||
|
- Total nights booked vs. available across all rooms
|
||||||
|
|
||||||
|
**Revenue Report:**
|
||||||
|
|
||||||
|
- Total revenue for the selected period
|
||||||
|
- Revenue breakdown by room
|
||||||
|
- Revenue breakdown by pricing tier (short-term, mid-term, long-term)
|
||||||
|
- Revenue from additional services
|
||||||
|
- Average booking value
|
||||||
|
|
||||||
|
**Guest Statistics:**
|
||||||
|
|
||||||
|
- Total guests and new guests in period
|
||||||
|
- Repeat guest rate (guests with 2+ bookings)
|
||||||
|
- Top guests by total spending
|
||||||
|
- Guest nationality distribution
|
||||||
|
- Average spending per guest
|
||||||
|
|
||||||
|
**Export Options:**
|
||||||
|
|
||||||
|
- **CSV Export** - Download report data as spreadsheet-compatible CSV
|
||||||
|
- **PDF Export** - Generate formatted PDF reports for printing or archiving
|
||||||
|
|
||||||
|
**Date Filters:**
|
||||||
|
|
||||||
|
- This Month (default)
|
||||||
|
- Last Month
|
||||||
|
- This Year
|
||||||
|
- Custom date range
|
||||||
|
|
||||||
## Shortcodes
|
## Shortcodes
|
||||||
|
|
||||||
Display buildings and rooms on your site using shortcodes:
|
Display buildings and rooms on your site using shortcodes:
|
||||||
|
|||||||
Reference in New Issue
Block a user