README.md in cloudflair-0.0.7 vs README.md in cloudflair-0.0.8
- old
+ new
@@ -53,18 +53,28 @@
This gem is organized along the URL schema of CloudFlare.
```ruby
require 'cloudflair'
-# https://api.cloudflare.com/client/v4/zones/cd7d068de3012345da9420df9514dad0
+# GET https://api.cloudflare.com/client/v4/zones/cd7d068de3012345da9420df9514dad0
Cloudflair.zone('023e105f4ecef8ad9ca31a8372d0c353').name
-# :=> "blog.example.com"
+# => "blog.example.com"
-# https://api.cloudflare.com/client/v4/zones/cd7d068de3012345da9420df9514dad0/settings/development_mode
+# GET https://api.cloudflare.com/client/v4/zones/cd7d068de3012345da9420df9514dad0/settings/development_mode
Cloudflair.zone('023e105f4ecef8ad9ca31a8372d0c353').settings.development_mode.value
-# :=> "on"
-# :=> "off"
+# => "on"
+# => "off"
+
+# PATCH https://api.cloudflare.com/client/v4/zones/cd7d068de3012345da9420df9514dad0/settings/development_mode
+# {"value"="on"}
+Cloudflair.zone('023e105f4ecef8ad9ca31a8372d0c353').settings.development_mode.tap do |dm|
+ dm.value = 'on'
+ dm.save
+end
+
+# GET https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records/372e67954025e0ba6aaa6d586b9e0b59
+Cloudflair.zone('023e105f4ecef8ad9ca31a8372d0c353').dns_record('372e67954025e0ba6aaa6d586b9e0b59').name
```
You can use any field that Cloudflare's API returns. If a field is covered by some internal field, use `_field`.
A good reference are also the specs.
@@ -83,14 +93,18 @@
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
## Roadmap
-* Pull Zone Information
-* Zone Name to Zone ID Lookup
-* Developer Mode, Cache Purge, Selective Cache Purge
-* Airbrake error reporting
+* ~~Pull Zone Information~~ ✅
+* ~~Zone Name to Zone ID Lookup~~ ✅
+* ~~Developer Mode, Cache Purge, Selective Cache Purge~~ ✅
+* ~~Airbrake error reporting~~ ❌ (It's the responsibility of the application, not the Gem)
+* Full read-only `/zones` API support
* Full API support
+
+### Whishlist
+
* Metrics reporting
* Rate Limit Tracking
* (Global) Rate Limit Tracking (redis?)
## About