shart 3.0.0 → 3.0.1

data/README.md

@@ -1,6 +1,6 @@
 # Shart
 
-Shart is designed to deploy [Middleman](http://middlemanapp.com/) websites, or sites built with other static site builders, to cloud storage providers, like Amazon S3 and [more](http://fog.io/0.8.1/storage/).
+Shart is a DRY approach to deploying websites generated by [Middleman](http://middlemanapp.com/), [Jekyll](http://jekyllrb.com/), or other static websites to cloud service providers that support website hosting, like [Amazon S3](http://aws.typepad.com/aws/2011/02/host-your-static-website-on-amazon-s3.html).
 
 ## Installation
 
@@ -18,19 +18,31 @@ Or install it yourself as:
 
 ## Usage
 
-Create a `Shartfile` in the root of your project.
+Create a `Shartfile` in the root of your project that looks like:
 
 ```ruby
-# A middleman Shartfile
+# A Middleman Shartfile.
 source './build'
 target 'your-aws-bucket-name', {
-  provider:               'AWS',
-  aws_secret_access_key:  'your AWS credentials',
-  aws_access_key_id:      'your AWS credentials'
+  :provider               =>  'AWS',
+  :aws_secret_access_key  =>  'your AWS credentials',
+  :aws_access_key_id      =>  'your AWS credentials'
 }
 ```
 
-Now run `shart` from your project root and BOOM! Your website will be deployed. If you're using Middleman, don't forget to run build first.
+When you're ready to publish your website, run:
+
+    $ shart
+
+Don't forget to run `middleman build` before you `shart` if you're using Middleman.
+
+After you successfully shart, be sure to [read the blog post about hosting a website on S3](http://aws.typepad.com/aws/2011/02/host-your-static-website-on-amazon-s3.html) if you haven't already configured your S3 bucket to do so.
+
+## Supported targets
+
+Shart has only been tested with Amazon S3 buckets.
+
+In theory, you can shart into any [storage provider that Fog supports](http://fog.io/0.8.1/about/getting_started.html).
 
 ## Contributing
 

data/bin/shart

@@ -4,14 +4,4 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'shart'
 
-Shart::DSL.shartfile('Shartfile')
-
-# target = Shart::Target.new 'tech.polleverywhere.com', {
-#   :provider                 => 'AWS',
-#   :aws_secret_access_key    => ENV['AWS_SECRET_ACCESS_KEY'],
-#   :aws_access_key_id        => ENV['AWS_ACCESS_KEY_ID']
-# }
-
-# source = Shart::Source.new('/Users/bradgessler/projects/polleverywhere/tech-blog/build')
-
-# target.sync source
+Shart::DSL.shartfile('Shartfile')

data/lib/shart.rb

@@ -21,7 +21,7 @@ module Shart
     end
 
     def sync(source)
-      Sync.new(source, self).sync
+      Sync.new(source, self).run
     end
   end
 
@@ -41,7 +41,7 @@ module Shart
     end
 
     def sync(target)
-      Sync.new(self, target).sync
+      Sync.new(self, target).run
     end
   end
 
@@ -63,7 +63,7 @@ module Shart
       sync = new.tap { |dsl| dsl.instance_eval(File.read(filename), filename) }.sync
       puts "Sharting from #{sync.source.root.to_s.inspect} to #{sync.target.directory_name.inspect}"
       sync.run do |path, key, file|
-        puts " #{key.inspect}"
+        puts " #{key}"
       end
     end
   end
@@ -82,7 +82,7 @@ module Shart
           :key => key,
           :body => File.open(path),
           :public => true,
-          :cache_control => 0 # Disable cache on S3 so that future sharts are visible if folks web browsers.
+          :cache_control => 'max-age=0' # Disable cache on S3 so that future sharts are visible if folks web browsers.
         })
       end
     end

data/lib/shart/version.rb

@@ -1,3 +1,3 @@
 module Shart
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shart
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
   prerelease: 
 platform: ruby
 authors: