Skip to content

Commit

Permalink
Rename package and update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HEKET313 committed Aug 6, 2018
1 parent 9937090 commit 704612b
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 4 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
# Health Check Bundle

This bundle adds `/health` endpoints to project
This bundle adds `/health` endpoints and `health:send-info` command to project.

You must just add it to your project and create class(-es) which implement interface
`Opitmax\HealthCheck\Service\HealthInterface`
For using this bundle you have to add configuration files:

* `config/routes/niklesh_health.yaml` (required)

```yaml
health_check:
resource: "@HealthCheckBundle/Controller/HealthController.php"
prefix: /
type: annotation
```
* `config/packages/hiklesh_health.yaml` (optional)

```yaml
health_check:
senders:
- 'App\Service\Sender'
```
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "niklesh/health-check",
"name": "niklesh/health-check-bundle",
"description": "Health check bundle",
"type": "symfony-bundle",
"license": "proprietary",
Expand Down

0 comments on commit 704612b

Please sign in to comment.