README.md in nunchaku-0.1.0 vs README.md in nunchaku-0.1.1
- old
+ new
@@ -1,6 +1,6 @@
-# Nunchaku
+# Nunchaku [![travis build status](https://secure.travis-ci.org/sitevalidator/nunchaku.png?branch=master)](http://travis-ci.org/sitevalidator/nunchaku) [![Code Climate](https://codeclimate.com/github/sitevalidator/nunchaku/badges/gpa.svg)](https://codeclimate.com/github/sitevalidator/nunchaku) [![Dependency Status](https://gemnasium.com/sitevalidator/nunchaku.png)](https://gemnasium.com/sitevalidator/nunchaku)
Nunchaku is a Ruby client for the [Nu HTML Checker](https://github.com/validator/validator). It lets you easily check HTML markup of web pages, by querying a remote instance of the checker.
![Nunchaku image](https://dl.dropboxusercontent.com/u/2268180/nunchaku/Nunchaku.png "Nunchaku image taken from http://commons.wikimedia.org/wiki/File:Nunchaku.png")
@@ -30,11 +30,11 @@
Then, you can check the JSON response like this:
```ruby
checker.raw # {
- # "url": "http://validationhell.com",
+ # "url": "http://example.com",
# "messages": [{
# "type": "error",
# "lastLine": 73,
# "lastColumn": 67,
# "firstColumn": 64,
@@ -63,13 +63,13 @@
The `messages` array contains all messages returned by the checker, but you'll typically be more interested in `errors` (that contains all messages of type "error") and `warnings` (that contains all messages of subtype "warning").
## Using an alternate server
-By default, Nunchaku will query the Nu HTML Checker at https://html5.validator.nu, but you're encouraged to install your own instance and use it instead. You can follow the [Nu installation instructions](https://github.com/validator/validator) and then specify the alternate server like this:
+By default, Nunchaku will query the Nu HTML Checker at http://validator.w3.org/nu but you're encouraged to install your own instance and use it instead. You can follow the [Nu installation instructions](https://github.com/validator/validator) and then specify the alternate server like this:
```ruby
-checker = Nunchaku.check('http://example.com', checker_uri: 'http://mychecker.example.com')
+Nunchaku.check('http://example.com', checker_uri: 'http://yourchecker.com')
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.