From 5ff8edb3b568d6edff9dd02ef42ebd561bf96001 Mon Sep 17 00:00:00 2001 From: Tac Tacelosky Date: Mon, 13 May 2024 13:08:09 -0600 Subject: [PATCH] doc: remove `$` so gitclip works (#304) Also, change app/console to bin/console --- README.md | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7f31011d..465d663e 100644 --- a/README.md +++ b/README.md @@ -36,8 +36,9 @@ Here's the web interface: ## Installation ## Install with composer: - - $ composer require liip/monitor-bundle +```bash +composer require liip/monitor-bundle +``` Then register the bundle in the `AppKernel.php` file: @@ -71,7 +72,9 @@ liip_monitor: And finally don't forget to install the bundle assets into your web root: - $ ./app/console assets:install web --symlink --relative +```bash +./app/console assets:install web --symlink --relative +``` ## Enabling built-in health checks @@ -185,16 +188,18 @@ my_reporter: ``` To run additional reporters with the CLI, add `--reporter=...` options for each one: - - $ ./app/console monitor:health --reporter=my_reporter - +```bash + ./app/console monitor:health --reporter=my_reporter +``` To run this reporter with the REST API, add a `reporters` query parameter: /monitor/health?reporters[]=my_reporter You can list available reporters with: - $ ./app/console monitor:list --reporters +```bash +bin/console monitor:list --reporters +``` ## Grouping Checks @@ -248,9 +253,10 @@ services: Both CLI commands have a `--group=...` option. If it is not given, the default group is used. - ./app/console monitor:list --group=app_server - - ./app/console monitor:health --group=app_server +```bash +bin/console monitor:list --group=app_server +bin/console monitor:health --group=app_server +``` Both commands, `monitor:list` and `monitor:health`, have an option `--all` to list or run the checks of all registered groups. Additionally, the `monitor:list` has an option `--groups` to list all registered groups.