README.md in middleman-caching-proxy-0.1.0 vs README.md in middleman-caching-proxy-0.1.2
- old
+ new
@@ -1,11 +1,10 @@
-# Middleman::Caching::Proxy
+# Middleman::CachingProxy
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/middleman/caching/proxy`. To experiment with that code, run `bin/console` for an interactive prompt.
+Caches the result of `proxy` calls allong with the fingerprint of their inputs.
+If the inputs remain the same, uses the cached version.
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -20,22 +19,53 @@
$ gem install middleman-caching-proxy
## Usage
-TODO: Write usage instructions here
+In `config.rb`:
+```ruby
+activate :caching_proxy
+
+things.each do |thing|
+ proxy_with_cache(
+ path: "/things/#{thing.slug}",
+ template: "/templates/thing_template.html",
+ proxy_options: {locals: {thing: thing}},
+ fingerprint: thing.updated_at.to_i
+ )
+end
+```
+
+There are 4 required parameters:
+
+* `path`: the page path,
+* `template`: the page template,
+* `proxy_options`: options to pass to the `proxy` invocation,
+* `fingerprint`: a value that indicates the 'version' of the item. If this
+ value changes, the cached version will be skipped and updated.
+
## Development
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you
+to experiment.
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/middleman-caching-proxy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/joeyates/middleman-caching-proxy. This project is intended
+to be a safe, welcoming space for collaboration, and contributors are expected
+to adhere to the [Contributor Covenant](http://contributor-covenant.org) code
+of conduct.
-
## License
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).