Skip to content

Commit

Permalink
Formatting enhancements for the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Philippe Hanrigou committed Jan 20, 2010
1 parent 36ce82f commit 2cdd385
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions README.markdown
@@ -1,4 +1,5 @@
== Synopsis
Synopsis
========

System Timer, a timer based on underlying `SIGALRM` system timers, is a
solution to Ruby processes which hang beyond the time limit when accessing
Expand All @@ -10,7 +11,8 @@ More background on:
* [http://ph7spot.com/musings/system-timer](http://ph7spot.com/musings/system-timer)
* [http://davidvollbracht.com/2008/6/2/30-days-of-teach-day-1-systemtimer](http://davidvollbracht.com/2008/6/2/30-days-of-teach-day-1-systemtimer)

== Usage
Usage
=====

require 'systemtimer'

Expand Down Expand Up @@ -55,23 +57,27 @@ More background on:
end


== Requirements
Requirements
============

SystemTimer only works on UNIX platforms (Mac OS X, Linux, Solaris, BSD, ...).
You can install the gem on Microsoft Windows, but you will only get
a convenience shell wrapping a simple call to timeout.rb under the cover.

== Install
Install
=======

sudo gem install systemtimer


== Authors
Authors
=======

* David Vollbracht <http://davidvollbracht.com>
* Philippe Hanrigou <http://ph7spot.com>

== Contributor
Contributor
===========

* Dmytro Shteflyuk <http://kpumuk.info/> :
- Changed from using Mutex to Monitor. Evidently Mutex causes thread
Expand All @@ -86,11 +92,13 @@ a convenience shell wrapping a simple call to timeout.rb under the cover.
<http://github.com/runix/system-timer/commit/d33acb3acc53d5105c68b25c3a2126fa682f12c0>
<http://github.com/runix/system-timer/commit/d8ca3452e462ea909d8e11a6091e7c30dfa3a1a8>

== Copyright
Copyright
=========

Copyright:: (C) 2008-2010 David Vollbracht & Philippe Hanrigou

== Description
Description
===========

While deploying Rails application in production our team discovered
that some web service call would not timeout way beyond their defined
Expand All @@ -115,7 +123,8 @@ timeout.rb, just a way to wrap sensitive call to system resources.
You can find more details on SystemTimer and how to use it
at http://ph7spot.com/articles/system_timer

== License
License
=======

(The Ruby License)

Expand Down

0 comments on commit 2cdd385

Please sign in to comment.