hokuto 0.0.1.8.1.8 → 0.0.2.8.1.8

data/README.md

@@ -1,6 +1,12 @@
 # Hokuto
 
-TODO: Write a gem description
+Hokuto: a lightweight appserver for rack-dependent ruby web applications.
+
+## Character
+
+Hokuto is a lightweight web application server focused to handle many many requests. This gem is based on Jetty. Due to Jetty's very artful request handling, this gem can take over the well known "C10K Problem".
+
+"Hokuto" is named after the express operated by Hokkaido Railway Company (a.k.a. JR Hokkaido). The express is the fastest train of the narrow guage trains in Japan for the average speed. It runs on tight curves quickly with the tilting system which is often called 'pendular'. I thought that this gem can be liken to the express train because of the fine mechanism to handle many many requests. This is why I named this gem.
 
 ## Installation
 
@@ -18,7 +24,18 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+If you just run it by the commands as follows:
+
+    $ hokuto
+
+Currently implemented options are below:
+    -p, --http-port=HTTP_PORT                   specify the HTTP port(default: 7080)
+    -c, --context-root=PATH                     specify the context root(default: /)
+    -d, --base-directory=DIR                    specify the root of apps(default: working directory)
+    -e, --environment=ENV                       specify the rack environment (default: 'development')
+    -sINSTANCES_ON_STARTUP, --min-instances     specify the number of JRuby instances on startup(default: 1)
+    -xMAXIMUM_INSTANCES, --max-instances        specify the maximum number of JRuby instances(default: 1)
+Note that your app will run the multithreaded mode if INSTANCES_ON_STARTUP == MAXIMUM_INSTANCES == 1 (default). If you want to perform highly with limited resources, you should not use multiple instances. Just you should implement apps in the multithreaded manner.
 
 ## Contributing
 

data/lib/hokuto/main.rb

@@ -51,7 +51,7 @@ module Hokuto
       parser.on('-P', '--https-port=SECURE_PORT'){|v|result[:https_port] = v}
       parser.on('-c', '--context-root=PATH'){|v|app_config[:context_root] = v}
       parser.on('-d', '--base-directory=DIR'){|v|app_config[:base_directory] = v}
-      parser.on('-e', '--environment=DIR'){|v|app_config[:environment] = v}
+      parser.on('-e', '--environment=ENV'){|v|app_config[:environment] = v}
       parser.on('-s', '--min-instances=INSTANCES_ON_STARTUP'){|v|app_config[:min_instances] = v}
       parser.on('-x', '--max-instances=MAXIMUM_INSTANCES'){|v|app_config[:max_instances] = v}
       parser.parse!

data/lib/hokuto/version.rb

@@ -1,3 +1,3 @@
 module Hokuto
-  VERSION = "0.0.1.8.1.8"
+  VERSION = "0.0.2.8.1.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hokuto
 version: !ruby/object:Gem::Version
-  version: 0.0.1.8.1.8
+  version: 0.0.2.8.1.8
   prerelease:
 platform: ruby
 authors: