dynamic_53 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e34de7925e2085889ace31594a9fa4d48c7c331
-  data.tar.gz: d2b767328cd595de21553d0866aa5b3b49242c4f
+  metadata.gz: 6e9615fde7d0bdd27eb81aa2b89e0804ab61febc
+  data.tar.gz: 8caef39b07227c52fd28a7ba7f46bcf700871093
 SHA512:
-  metadata.gz: 3c1e43d841ff94ba97c6938286ff960e4efbdd9da644c23a702680f66d99908b2534220cebd414738b2c7c5deb7da43b194a4536913c34a9566cb6e5b352aad5
-  data.tar.gz: f6d477c106f5d50dc10ce1b40aabd30f10fc8634a341947b42e2dc998716b7db899a9ef651a6464c498b59904ba7eadbf553028e3c1883ae9c529347c2174a65
+  metadata.gz: 5e8de9b61eec7c8471082b8b4bec37b157deda82062de22f194fb14226887b5ce9ca26c0a4728e644a5ee36b1cc1c1f8d29d2d13dd20278fe1bcbbf74d18ac29
+  data.tar.gz: 64dd85d3743353102d04ee3d658922c590fb7e2ad6255634127eac2f7a26a082e6e517ed2e26efc2f40f1207f2fdf0f9176edf752812272838abf8288a13c2fc

data/README.md

@@ -24,15 +24,37 @@ Or install it yourself as:
 
 ## Usage
 
+Note that AWS credentials are expected to be provided in the environment variables `AWS_ACCESS_KEY_ID` and
+`AWS_SECRET_ACCESS_KEY`. Refer to Amazon Web Services console to create a user with the credentials to make updates
+in Route 53.
+
+### Command line
+
 Run the command as following:
 
     $ dynamic_53 -z example.com. -h dynamic.example.com.
 
 This will update the host "dynamic.example.com." within the route 53 zone "example.com." with you current IP address.
 
-Note that AWS credentials are expected to be provided in the environment variables `AWS_ACCESS_KEY_ID` and
-`AWS_SECRET_ACCESS_KEY`. Refer to Amazon Web Services console to create a user with the credentials to make updates
-in Route 53.
+    $ dynamic_53 --help
+
+For command line options.
+
+The task can be set up in a crontab like so, to update hourly:
+
+```
+1 * * * * AWS_SECRET_ACCESS_KEY=secret AWS_ACCESS_KEY_ID=key /path/to/bin/dynamic_53 -z example.com. -h hostname.example.com.
+```
+
+After installing the gem do `which dynamic_53` to get its full path.
+
+### From ruby
+
+```ruby
+options = {verbose: false}
+client = Dynamic53.new(zone, hostname, options)
+client.update # => updates the above zone and hostname with the current machine's public IP address.
+```
 
 ## Development
 

data/dynamic_53.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["matt.connolly@me.com"]
   spec.summary       = %q{A simple tool to update Amazon Route 53 with based on your current IP Address.}
   spec.description   = %q{A simple tool to update Amazon Route 53 with based on your current IP Address.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/mattconnolly/dynamic_53"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/dynamic_53/version.rb

@@ -1,3 +1,3 @@
 class Dynamic53
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamic_53
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Matt Connolly
@@ -89,7 +89,7 @@ files:
 - spec/dynamic_53/cli_spec.rb
 - spec/dynamic_53_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/mattconnolly/dynamic_53
 licenses:
 - MIT
 metadata: {}