Westernstadt

Only the facade counts.

Installation

Create a Gemfile

#!/usr/bin/env bundle

source 'https://rubygems.org'

gem 'bitaculous-westernstadt', github: 'bitaculous/westernstadt', require: false

Run bundle to install all dependencies with Bundler

Usage

Create a Rack configuration

#!/usr/bin/env rackup

# This file is used by Rack-based servers to start the application.

require 'bundler/setup'

require 'bitaculous/westernstadt/engine'

engine = Bitaculous::Westernstadt::Engine.new
engine.settings.set :root, Dir.pwd

run engine

Run Westernstadt with rackup or your favorite Ruby Webserver

Development

Run specs with RSpec

Run rspec.

or via Guard:

$ guard -g spec

See Test Coverage

Run COVERAGE=true rspec.

Run RuboCop

Run rubocop.

To run all specs and RuboCop altogether, run rake.

Bug Reports

Github Issues are used for managing bug reports and feature requests. If you run into issues, please search the issues and submit new problems here.

Versioning

This library aims to adhere to Semantic Versioning 2.0.0. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, that version should be immediately yanked and / or a new version should be immediately released that restores compatibility.

License

Westernstadt is released under the MIT License (MIT), see LICENSE.