README.md in rhinestone-0.0.1 vs README.md in rhinestone-0.0.2

- old
+ new

@@ -4,28 +4,41 @@ It has bothered me, so I wrote Rhinestone: a simple proxy caches both the gems and the gem metadata. It updates the cache *after* returning the response, so you get data that might be a little stale, but you get it very quickly. You should deploy it somewhere in your local network (so that more people use the same cache). -# Installation +## Installation Just install it from RubyGems: gem install rhinestone -# Running +Below is the upstart script I used to make it run on Ubuntu: -It's as simple as running: +``` +# File: /etc/init/rhinestone.conf - rhinestone +# Rhinestone - a RubyGems.org proxy -Rhinestone uses Goliath underneath, so there are more switches you can use: +description "rhinestone proxy server" - $ rhinestone --help +start on runlevel [23] +stop on shutdown - Usage: <server> [options] +exec sudo rhinestone -p 80 -e prod -l /var/log/rhinestone.log -P /var/run/rhinestone.pid -C /var/rhinestone/cache +respawn +``` + +## Running + +It's as simple as running: + + rhinestone + +Rhinestone uses Goliath underneath, so there are some switches you can use: + Server options: -e, --environment NAME Set the execution environment (prod, dev or test) (default: development) -a, --address HOST Bind to HOST address (default: 0.0.0.0) -p, --port PORT Use PORT (default: 9000) -S, --socket FILE Bind to unix domain socket @@ -45,5 +58,28 @@ --ssl-verify Enables SSL certificate verification Common options: -v, --verbose Enable verbose logging (default: false) -h, --help Display help message + + Rhinestone-specific options: + -C, --cache-path DIRECTORY The directory where cache files will be stored + + +## Usage + +Assuming you have Rhinestone running somewhere in your local network, add this to your Gemfile: + + source :rubygems + source "http://rhinestone.local" # the address of rhinestone + +This will speed up `bundle install` about 5-6x times, and even more if you remove the rubygems part completely (but I don't recommend that). +Note that the Rhinestone line is beneath rubygems one. +Otherwise bundler would download most of the gems directly from Rubygems and not from the proxy. + +## Author + +Adam Pohorecki + +## License + +MIT, see the MIT-LICENSE file.