instructions to how to use the binary + bump version to the first 1.0.0 alpha

did committed Feb 17, 2015

commit 6bde6c350b498ca243a2e37819973da494e8c458

Showing 5 changed files with 58 additions and 50 deletions

README.md +17 -8

@@	@@ -2,21 +2,30 @@

	[![Code Climate](https://codeclimate.com/github/locomotivecms/steam/badges/gpa.svg)](https://codeclimate.com/github/locomotivecms/steam) [![Dependency Status](https://gemnasium.com/locomotivecms/steam.svg)](https://gemnasium.com/locomotivecms/steam) [![Build Status](https://travis-ci.org/locomotivecms/steam.svg?branch=master)](https://travis-ci.org/locomotivecms/steam) [![Coverage Status](https://coveralls.io/repos/locomotivecms/steam/badge.svg?branch=master)](https://coveralls.io/r/locomotivecms/steam?branch=master)

-	The rendering stack used by both Wagon and Engine. It includes the rack stack and the liquid drops/filters/tags.
+	The rendering stack used by both Wagon and Engine (WIP). It includes:

-	## Installation
+	- the rack stack to serve assets (SCSS, Coffeescript, ...etc) and pages
+	- the liquid drops/filters/tags libs to parse and render liquid templates
+	- a filesystem repository which reads the source of a site written for Wagon

-	Add this line to your application's Gemfile:
+	Note: Steam passes all the specifications from Wagon.

-	gem 'locomotivecms_steam'
+	## Installation [WIP]

-	And then execute:
+	gem install thin
+	gem install locomotivecms_steam --pre

-	$ bundle
+	## Usage

-	Or install it yourself as:
+	steam <PATH to a Wagon site>

-	$ gem install locomotivecms_steam
+	open your browser
+
+	open localhost:8080
+
+	## TODO
+
+	see the list in the issues section.

	## Contributing

bin/steam.rb +40 -0

@@	@@ -0,0 +1,40 @@
+	#!/usr/bin/env ruby
+
+	require 'rubygems'
+	require 'bundler/setup'
+
+	Bundler.require
+
+	require 'thin'
+
+	require_relative '../lib/locomotive/steam'
+	require_relative '../lib/locomotive/steam/server'
+
+	path = ARGV[0] \|\| ENV['SITE_PATH'] \|\| File.join(File.expand_path(File.dirname(__FILE__)), '../spec/fixtures/default')
+
+	Locomotive::Steam.configure do \|config\|
+	config.mode = :test
+	end
+
+	Locomotive::Common.reset
+	Locomotive::Common.configure do \|config\|
+	config.notifier = Locomotive::Common::Logger.setup(File.join(path, 'log/steam.log'))
+	end
+
+	server = Locomotive::Steam::Server.new({
+	path: path,
+	serve_assets: true,
+	minify_assets: false
+	})
+
+	# Note: alt thin settings (Threaded)
+	server = Thin::Server.new('localhost', '8080', server.to_app)
+	server.threaded = true
+	server.start
+	# FIXME: Rack::Handler::Thin.run server.to_app (not threaded)
+
+	# WEBRick rack handler
+	# Rack::Handler::WEBrick.run server.to_app
+
+	Locomotive::Common::Logger.info 'Server started...'
+

example/server.rb +0 -40

@@	@@ -1,40 +0,0 @@
-	#!/usr/bin/env ruby
-
-	require 'rubygems'
-	require 'bundler/setup'
-
-	Bundler.require
-
-	require 'thin'
-
-	require_relative '../lib/locomotive/steam'
-	require_relative '../lib/locomotive/steam/server'
-
-	path = ENV['SITE_PATH'] \|\| File.join(File.expand_path(File.dirname(__FILE__)), '../spec/fixtures/default')
-
-	Locomotive::Steam.configure do \|config\|
-	config.mode = :test
-	end
-
-	Locomotive::Common.reset
-	Locomotive::Common.configure do \|config\|
-	config.notifier = Locomotive::Common::Logger.setup(File.join(path, 'log/steam.log'))
-	end
-
-	server = Locomotive::Steam::Server.new({
-	path: path,
-	serve_assets: true,
-	minify_assets: false
-	})
-
-	# Note: alt thin settings (Threaded)
-	server = Thin::Server.new('localhost', '8080', server.to_app)
-	server.threaded = true
-	server.start
-	# FIXME: Rack::Handler::Thin.run server.to_app (not threaded)
-
-	# WEBRick rack handler
-	# Rack::Handler::WEBrick.run server.to_app
-
-	Locomotive::Common::Logger.info 'Server started...'
-

locomotive/steam/version.rb b/lib/locomotive/steam/version.rb +1 -1

@@	@@ -3,6 +3,6 @@
	# 1.0.0-alpha < 1.0.0-alpha.1 < 1.0.0-alpha.beta < 1.0.0-beta < 1.0.0-beta.2 < 1.0.0-beta.11 < 1.0.0-rc.1 < 1.0.0
	module Locomotive
	module Steam
-	VERSION = '0.2.0-beta'
+	VERSION = '1.0.0-alpha'
	end
	end

locomotivecms_steam.gemspec +0 -1

@@	@@ -42,7 +42,6 @@ Gem::Specification.new do \|spec\|
	spec.add_dependency 'mimetype-fu', '~> 0.1.2'
	spec.add_dependency 'mime-types', '~> 2.4.3'

-
	spec.add_dependency 'locomotivecms-solid', '~> 4.0.0.alpha2'
	spec.add_dependency 'locomotivecms_common', '~> 0.0.2'