README

aspen
    by Kevin Williams
    https://kevwil.github.io/aspen/

== DESCRIPTION:

Aspen is a web server engine for JRuby. The design is very similar
to Thin (https://rubygems.org/gems/thin), except
using Netty (https://netty.io) for high-speed concurrent sockets.

== FEATURES/PROBLEMS:

* truly concurrent socket model
* Rack interface support
* Not all features implemented yet, such as chunked data, different content encodings, etc.

== SYNOPSIS:

  Sample code can be found in the examples directory.

== REQUIREMENTS:

* Java 8 (I'm using 22 but targeting 8)
* JRuby (currently 9.4.8.0)
* Rack >= 1.1 (I'm using 1.2 but trying to retain 1.1 compatibility)

== INSTALL:

	# From Gemcutter / Rubyforge ...
	$ (sudo) jruby -S gem install aspen
	
	# if using JRuby via RVM (https://rvm.io/) which I highly recommend doing
	$ gem install aspen

== INSTALL FROM SOURCE:

    # get source from Github
    $ git clone https://github.com/kevwil/aspen.git
    $ cd aspen

    # You must have JRuby set up, with the dependent gems installed.
    # see the Rakefile for the dev-time dependencies
    $ jgem install bones-rcov bones-yard bones-extras rspec mocha

    # You must have Ant (https://ant.apache.org) and Maven (https://maven.apache.org) set up.
    # *note* the Rakefile will call Maven in "offline mode".
    # If you get any errors about unresolved dependencies, do this:
    $ cd javalib
    $ mvn dependency:go-offline (or 'mvn package')

    # Now you can build and test Aspen
    $ jruby -S rake

    # Install the gem
    $ jruby -S rake gem:install

== LICENSE:

(The MIT License)

Copyright (c) 2009-2011 Kevin Williams

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.