forkr 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5d07d7a19b09e4439b0bd17a329a5f0c28ff283
-  data.tar.gz: 70a3e17c480fdf37e030bf46e0329a5796a3884a
+  metadata.gz: 792ef4385e7d43266984bd7068d5b057d6dab7c2
+  data.tar.gz: 97833ed0afd879331e79200c875e69aa4f5a7c68
 SHA512:
-  metadata.gz: c0f49a4b03d3870e4d48044df62184c01aac45e4c5c6350f19d2c6893841b4f4a943d06155d4ec16cabf493e28ef571172e802617e454e4a5047cd8f70ea2ec6
-  data.tar.gz: 5f4f8956964354daec82892e9c6af04b8b28534adeddca01430034fc793d74359fcf6dc40a9394ec4c3c0383ec5234074770275ba468a9fdb8fa7f45c990e545
+  metadata.gz: e5632df6fc33a3808015c2ddb35e144eb75aed92147f5c20c2b46e322a5e2434cbbbd7d4ba82a0b88a0eaf528b4568c4952b581cf56e326ad9600e415f72f0b1
+  data.tar.gz: 547e21ee34d000acf5b3ddeebde52d2ff22c22e626fecdabf5f065f8fc7dd64b431f3d1c67f32769049ca95c7385f121fc1741a853da6e6b6d84a972e0298b6c

data/README.md

@@ -0,0 +1,27 @@
+# Forkr
+Forkr is a preforking worker host, shamelessly inspired by unicorn.
+
+It exists to easily fork and scale ruby programs which aren't rack-based.
+
+## What Forkr does for you
+Forker provides a master management process which oversees and restarts your workers for you.
+
+The Forkr master will respond to the TTIN and TTOU signals and automatically add or remove workers.
+
+The Forkr master also responds to the standard unix TERM, QUIT, and INT signals, forwarding those to your workers.
+
+## What you must provide
+You need to provide a single object, called a Forklet.  This object must respond to a single, parameterless method called run.
+
+Your run method will be invoked after forking - this is the time to close or reopen any file descriptors or the like.
+
+In your run method, you will need to:
+* Block the current thread - make sure to do this or Forkr will get confused and continue restarting your workers.  It thinks they have died.
+* Respond properly to the TERM, QUIT, and INT signals
+
+## How to use it
+Provided you already have a forklet and a number of workers you want to run (let's say 3) you can start the master simply with:
+
+```ruby
+    Forkr.new(forklet, 3).run  
+```

data/forkr.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name        = 'forkr'
+  s.version     = '0.1.4'
+  s.date        = '2014-12-03'
+  s.summary     = "A pre-forking worker host - shamelessly inspired by unicorn."
+  s.description = "A pre-forking worker host."
+  s.authors     = ["Trey Evans"]
+  s.email       = 'lewis.r.evans@gmail.com'
+  s.files       = ["lib/forkr.rb", "forkr.gemspec", "README.md"]
+  s.homepage    = 'https://github.com/TreyE/forkr'
+  s.license     = 'MIT'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forkr
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Trey Evans
@@ -16,6 +16,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- forkr.gemspec
 - lib/forkr.rb
 homepage: https://github.com/TreyE/forkr
 licenses: