README.md in cloud_party-0.1.1.pre.alpha.1 vs README.md in cloud_party-0.1.1

- old
+ new

@@ -1,30 +1,36 @@ +# CloudParty +HTTParty based library for Cloudflare + +### SonarCloud +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=iotaspencer_gem_cloud_party&metric=alert_status)](https://sonarcloud.io/dashboard?id=cloud_party) +[![Code Smell](https://sonarcloud.io/api/project_badges/measure?project=iotaspencer_gem_cloud_party&metric=code_smells)](https://sonarcloud.io/dashboard?id=cloud_party) + +### Badges [![Gem Version](https://badge.fury.io/rb/cloud_party.svg)](https://badge.fury.io/rb/cloud_party) [![Code Climate](https://codeclimate.com/github/IotaSpencer/cloud_party/badges/gpa.svg)](https://codeclimate.com/github/IotaSpencer/cloud_party) [![Test Coverage](https://codeclimate.com/github/IotaSpencer/cloud_party/badges/coverage.svg)](https://codeclimate.com/github/IotaSpencer/cloud_party/coverage) [![Build Status](https://travis-ci.org/IotaSpencer/cloud_party.svg?branch=master)](https://travis-ci.org/IotaSpencer/cloud_party) -# CloudParty -Super thin Ruby wrapper for Cloudflare's V4 API. ## Installation Add this line to your application's Gemfile: -```ruby +``` gem 'cloud_party' ``` And then execute: -```shell +``` $ bundle ``` Or install it yourself as: -```shell +``` $ gem install cloud_party ``` ## Usage @@ -96,11 +102,11 @@ ``` #### Add(POST) an A Record to the zone ```ruby -dns_record = connection.post('zones/{#zone.result[:id]}/dns_records', { +dns_record = connection.post('zones/#!{#zone.result[:id]}/dns_records', { type: 'A', name: 'supercooldomain.com', content: '127.0.0.1' }) @@ -109,11 +115,11 @@ ``` #### DELETE a zone ```ruby -deleted_zone = connection.delete('zones/#{zone.result[:id]}') +deleted_zone = connection.delete('zones/#!{zone.result[:id]}') # Check out the response p deleted_zone ``` @@ -121,11 +127,11 @@ ```ruby begin connection.get('user') rescue => e - # Inspect e.reponse for more details + # Inspect e.response for more details p e.response end ``` ## Development @@ -136,9 +142,12 @@ ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/trev/rubyflare. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct. +## Legal +cloud_party, its developers, and other collaborators are not affiliated with nor endorsed by Cloudflare unless explicitly +noted ## License The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).