README.md in stillwater-0.0.1 vs README.md in stillwater-0.0.2
- old
+ new
@@ -1,7 +1,10 @@
# Stillwater
+[![Build Status](https://secure.travis-ci.org/trobrock/stillwater.png?branch=master)](http://travis-ci.org/trobrock/stillwater)
+[![Build Status](https://gemnasium.com/trobrock/stillwater.png)](https://gemnasium.com/trobrock/stillwater)
+
A simple connection pool, that allows connections to different servers (or anything else)
## Installation
Add this line to your application's Gemfile:
@@ -16,26 +19,28 @@
$ gem install stillwater
## Usage
- pool = Stillwater::ConnectionPool.new
- %q{ host1.com host2.com }.each do |host|
- pool.add { MyConnectionClass.new(host) }
- end
+```ruby
+pool = Stillwater::ConnectionPool.new
+%q{ host1.com host2.com }.each do |host|
+ pool.add { MyConnectionClass.new(host) }
+end
- # Basic connection handling
- pool.with_connection do |connection|
- # Do some stuff with your connection
- end
+# Basic connection handling
+pool.with_connection do |connection|
+ # Do some stuff with your connection
+end
- # Retry connections
- # This will retry your code with a new connection and mark the tried
- # connection as bad. The bad connection will be put back in the pool
- # at the default period of 5 minutes.
- pool.retry_connection_from(ServerConnectionFailed) do |connection|
- # Do some stuff with your connection
- end
+# Retry connections
+# This will retry your code with a new connection and mark the tried
+# connection as bad. The bad connection will be put back in the pool
+# at the default period of 5 minutes.
+pool.retry_connection_from(ServerConnectionFailed) do |connection|
+ # Do some stuff with your connection
+end
+```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)