README.md in bidu-house-0.1.2 vs README.md in bidu-house-0.2.0
- old
+ new
@@ -4,14 +4,14 @@
This gem tries to make server monitoring easier and more reliable by adding an easly configurable
report and making it avaliable in a controller
Getting started
---------------
-1. Add JsonParser to your `Gemfile` and `bundle install`:
+1. Add House to your `Gemfile` and `bundle install`:
```ruby
- gem 'json_parser'
+ gem 'bidu-house'
```
2. Include in your health check controller passing the configuration to fetch your Documents
with error and render the report
@@ -49,17 +49,17 @@
- external_key: column to be exposed as id for the objects with error
- threshold: default report threshold (default: 0.02)
- period: default search period (default: 1 day)
- on: report bucket (default: :default)
- 4. Run the server and hit the health-check routes
+4. Run the server and hit the health-check routes
```
wget http://localhost:3000/health-check/status
wget http://localhost:3000/health-check/late-status
```
5. Customize your request for multiple reports
```
wget http://localhost:3000/health-check/status?period=3.days&threshold=0.005
wget http://localhost:3000/health-check/late-status?period=1.hours&threshold=0.1
- ```
\ No newline at end of file
+ ```