Skip to content

Commit b86e11e

Browse files
committed
docs: update README to reflect changes in asset publishing process
Revise the documentation to remove references to automatic asset publishing and emphasize manual publishing options. The updated README now includes enhanced command options for better control over the publishing process, clarifying the use of the `--clean` and `--force` flags. This aligns the documentation with recent changes in the package's asset management functionality.
1 parent 4e52d4a commit b86e11e

1 file changed

Lines changed: 15 additions & 38 deletions

File tree

README.md

Lines changed: 15 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -119,55 +119,33 @@ return [
119119
```
120120
### Assets & Views
121121

122-
#### Automatic Publishing (Recommended)
123-
124-
The package includes **automated asset publishing** that automatically updates views and assets when the package is updated. This feature is enabled by default and requires no manual intervention.
125-
126-
When you update the package via Composer, the system will:
127-
- Automatically detect the version change
128-
- Clean up old published files
129-
- Republish the latest views and assets
130-
- Log the process for transparency
131-
132-
#### Manual Publishing
133-
134-
You can still manually publish assets and views if needed:
135-
122+
Publish dashboard assets:
136123
```bash
137-
# Publish assets
138124
php artisan vendor:publish --tag="request-analytics-assets"
125+
```
139126

140-
# Publish views for customization
127+
Optionally, publish the views for customization:
128+
```bash
141129
php artisan vendor:publish --tag="request-analytics-views"
142-
143-
# Or use the enhanced command with cleanup
144-
php artisan request-analytics:publish --clean --force
145130
```
146131

147-
#### Configuration
148-
149-
Control the auto-publishing behavior in your `.env` file:
150-
151-
```env
152-
# Enable/disable auto-publishing (default: true)
153-
REQUEST_ANALYTICS_AUTO_PUBLISH_ON_UPDATE=true
132+
#### Enhanced Publishing Command
154133

155-
# Clean up old files before publishing (default: true)
156-
REQUEST_ANALYTICS_CLEANUP_BEFORE_PUBLISH=true
134+
Use the enhanced command for better control over the publishing process:
157135

158-
# Force overwrite existing files (default: true)
159-
REQUEST_ANALYTICS_FORCE_PUBLISH=true
136+
```bash
137+
# Publish with cleanup (removes old files first)
138+
php artisan request-analytics:publish --clean --force
160139

161-
# Log publishing activities (default: true)
162-
REQUEST_ANALYTICS_LOG_PUBLISHING=true
140+
# Publish without cleanup (preserves existing files)
141+
php artisan request-analytics:publish --force
163142
```
164143

165-
To disable auto-publishing completely:
166-
```env
167-
REQUEST_ANALYTICS_AUTO_PUBLISH_ON_UPDATE=false
168-
```
144+
**Command Options:**
145+
- `--clean`: Clean up old published files before publishing new ones
146+
- `--force`: Force overwrite existing files
169147

170-
When disabled, you'll need to manually republish after package updates:
148+
**Note:** After package updates, you may need to republish assets and views to get the latest template changes:
171149
```bash
172150
php artisan request-analytics:publish --clean --force
173151
```
@@ -235,7 +213,6 @@ protected function schedule(Schedule $schedule): void
235213
- **Queue Support**: Background processing for high-traffic applications
236214
- **REST API**: Complete programmatic access to analytics data
237215
- **Laravel Integration**: Seamless integration with Laravel's authentication and middleware systems
238-
- **Automated Publishing**: Smart asset and view management with automatic updates
239216

240217
## Usage
241218

0 commit comments

Comments
 (0)