README.md in pinglish-0.0.1 vs README.md in pinglish-0.1.0
- old
+ new
@@ -27,20 +27,20 @@
0. The response __must__ be valid JSON no matter what, even if JSON
serialization or other fundamental code fails.
0. The response __must__ contain a `"status"` key set either to `"ok"`
- or `"fail"`.
+ or `"failures"`.
0. The response __must__ contain a `"now"` key set to the current
server's time in seconds since epoch as a string.
-0. If the `"status"` key is set to `"fail"`, the response __may__
+0. If the `"status"` key is set to `"failures"`, the response __may__
contain a `"failures"` key set to an Array of string names
representing failed checks.
-0. If the `"status"` key is set to `"fail"`, the response __may__
+0. If the `"status"` key is set to `"failures"`, the response __may__
contain a `"timeouts"` key set to an Array of string names
representing checks that exceeded an implementation-specific
individual timeout.
0. The response body __may__ contain any other top-level keys to
@@ -54,11 +54,11 @@
{
// These two keys will always exist.
"now": "1359055102",
- "status": "fail",
+ "status": "failures",
// This key may only exist when a named check has failed.
"failures": ["db"],
@@ -73,12 +73,10 @@
}
```
## The Middleware
-FIX: exegesis
-
```ruby
require "pinglish"
use Pinglish do |ping|
@@ -106,16 +104,12 @@
ping.check :long, :timeout => 5 do
App.dawdle
end
- # Signal check failure by raising an exception.
+ # Signal check failure by raising an exception. Any exception will do.
ping.check :fails do
- false or raise "Everything's ruined."
+ raise "Everything's ruined."
end
end
```
-
-## Contributing
-
-FIX