diff --git a/README.md b/README.md index 84968d0..d3e9188 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # sprinkle-worker -"Background" worker sprinkle for userfrosting \ No newline at end of file +"Background" worker sprinkle for userfrosting + +The following snippit creates a single worker thread for processing tasks: +``` +[Unit] +Description=UserFrosting workers service + +[Service] +Restart=on-failure +Type=simple +PIDFile=/run/uf-workers.pid +ExecStart=php bakery worker:run --quiet +WorkingDirectory=/srv/UserFrosting +User=www-data +Group=www-data +SyslogIdentifier=UF-worker + +[Install] +WantedBy=multi-user.target +``` \ No newline at end of file