README.md in cloudflare-1.0.0 vs README.md in cloudflare-1.1.0
- old
+ new
@@ -1,15 +1,27 @@
+NOTICE
+======
+
+In version v1.1.0 I renamed some functions in Client API.
+
+- threat_score -> ip_lkup
+- set_cache_lvl -> cache_lvl
+- set_security_lvl -> sec_lvl
+- purge_cache -> fpurge_ts
+- update_image -> zone_grab
+
+
CloudFlare
==========
It is a Ruby wrapper for the CloudFlare API.
-Official home page is [here](http://b4k3r.github.com/cloudflare). The complete [RDoc](http://rdoc.info/github/B4k3r/cloudflare/) is online.
+Official home page is [here](https://github.com/B4k3r/cloudflare). The complete [RDoc](http://rdoc.info/github/B4k3r/cloudflare/) is online.
Visit also a CloudFlare API documentation:
-- [Client](http://www.cloudflare.com/wiki/Client_Interface_API)
+- [Client](http://www.cloudflare.com/docs/client-api.html)
- [Host](http://www.cloudflare.com/docs/host-api.html)
Installation
------------
@@ -33,35 +45,35 @@
cf = CloudFlare.new('user_api_key', 'user_email')
output = cf.add_rec('domain.com', 'A', '212.11.6.211', 'subdomain.domain.com', true)
if output['result'] == 'success'
- puts 'Successfuly added DNS record'
+ puts 'Successfuly added DNS record'
else
- puts output['msg'] // error message
+ puts output['msg'] # error message
end
```
**Example for Host API:**
```
require 'cloudflare'
cf = CloudFlare.new('host_api_key')
-output = cf.create_user('new_user_email', 'new_password', 'new_username (optional)', 'unique id (optional)')
+output = cf.create_user('john@example.com', 'secret', 'john')
if output['result'] == 'success'
- puts output['msg']
- puts "Your login is #{output['response']['cloudflare_username']}"
+ puts output['msg']
+ puts "Your login is #{output['response']['cloudflare_username']}" # => john
else
- puts output['msg'] // error message
+ puts output['msg'] # error message
end
```
License
-------
-Copyright © 2012. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+Copyright © 2012 - 2013. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.