Skip to content

Commit 2f50878

Browse files
committed
update docs
1 parent b4b3d1e commit 2f50878

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,29 @@
1313
### Basic Usage
1414

1515
```ruby
16-
> check = GitHubPages::HealthCheck.new("choosealicense.com")
17-
=> #<GitHubPages::HealthCheck @domain="choosealicense.com" valid?=true>
16+
> check = GitHubPages::HealthCheck::Site.new("choosealicense.com")
17+
=> #<GitHubPages::HealthCheck::Site @domain="choosealicense.com" valid?=true>
1818
> check.valid?
1919
=> true
2020
```
2121

2222
### An invalid domain
2323

2424
```ruby
25-
> check = GitHubPages::HealthCheck.new("foo.github.com")
25+
> check = GitHubPages::HealthCheck::Site.new("foo.github.com")
2626
> check.valid?
2727
=> false
2828
> check.valid!
29-
=> GitHubPages::HealthCheck::InvalidCNAME
29+
=> GitHubPages::HealthCheck::Errors::InvalidCNAMEError
3030
```
3131

3232

3333
### Retrieving specific checks
3434

3535
``` ruby
36-
> check.should_be_a_record?
36+
> check.domain.should_be_a_record?
3737
=> true
38-
> check.a_record?
38+
> check.domain.a_record?
3939
=> true
4040
```
4141

@@ -56,15 +56,14 @@
5656
:pages_domain?=>false,
5757
:valid?=>true
5858
}
59-
> require "json"
6059
> check.to_json
6160
=> "{\"cloudflare_ip?\":false,\"old_ip_address?\":false,\"a_record?\":true,\"cname_record?\":false,\"valid_domain?\":true,\"apex_domain?\":true,\"should_be_a_record?\":true,\"pointed_to_github_user_domain?\":false,\"pointed_to_github_pages_ip?\":false,\"pages_domain?\":false,\"valid?\":true}"
6261
```
6362

6463
### Getting the reason a domain is invalid
6564

6665
```ruby
67-
> check = GitHubPages::HealthCheck.new "developer.facebook.com"
66+
> check = GitHubPages::HealthCheck::Site.new "developer.facebook.com"
6867
> check.valid?
6968
=> false
7069
> check.reason

0 commit comments

Comments
 (0)