add doc

Joel AZEMAR committed Apr 01, 2014

commit b8b192dbfe31ccaffd6a89d8bef68b5318e17c6f

Showing 4 changed files with 79 additions and 2 deletions

CHANGELOG.md +19 -0

@@	@@ -0,0 +1,19 @@
+	### VERSION 0.0.1
+
+	* bug fix
+	*
+
+	* refactoring
+	*
+
+	* enhancements
+	*
+
+	* backwards incompatible changes
+	*
+
+	* deprecations
+	*
+
+	* todos
+	*
	\ No newline at end of file

README.md +33 -1

@@	@@ -1,4 +1,36 @@
-	steam
+	Steam
	======

	The rendering stack used by both Steam and Station (new name of the engine). It includes the rack stack and the liquid drops/filters/tags.
+
+	[![Gem Version](https://badge.fury.io/rb/steam.png)](http://badge.fury.io/rb/steam)
+
+	[![Code Climate](https://codeclimate.com/github/locomotivecms/steam.png)](https://codeclimate.com/github/locomotivecms/steam)
+
+	[![Dependency Status](https://gemnasium.com/locomotivecms/steam.png)](https://gemnasium.com/locomotivecms/steam)
+
+	[![Build Status](https://travis-ci.org/locomotivecms/steam.png?branch=master)](https://travis-ci.org/locomotivecms/steam) (Travis CI)
+
+	[![Coverage Status](https://coveralls.io/repos/locomotivecms/steam/badge.png)](https://coveralls.io/r/locomotivecms/steam)
+
+	## Installation
+
+	Add this line to your application's Gemfile:
+
+	gem 'locomotivecms_steam'
+
+	And then execute:
+
+	$ bundle
+
+	Or install it yourself as:
+
+	$ gem install locomotivecms_steam
+
+	## Contributing
+
+	1. Fork it ( http://github.com/<my-github-username>/locomotivecms/steam )
+	2. Create your feature branch (`git checkout -b my-new-feature`)
+	3. Commit your changes (`git commit -am 'Add some feature'`)
+	4. Push to the branch (`git push origin my-new-feature`)
+	5. Create new Pull Request

bin/publish +26 -0

@@	@@ -0,0 +1,26 @@
+	#!/usr/bin/env ruby
+
+	# bin/publish 0.0.1
+
+	class Publish
+
+	def start version, rvm=false
+	system "rvm use #{rvm}"
+
+	system "bundle && bundle exec rspec"
+	system "gem build steam.gemspec"
+	system "git tag -a v#{version} -m 'version #{version}'"
+	system "git push --tags"
+	system "gem push steam-#{version}.gem"
+	system "git push origin master"
+	end
+
+	end
+
+	if ARGV.length != 1 # or !ARGV[0].match(/\d{1,3}.\d{1,3}.\d{1,3}/)
+	puts 'HELP: '
+	puts '$ bin/publish 0.0.1 ruby-2.1.1@steam'
+	exit 0
+	end
+
+	Publish.new.start ARGV[0]
	\ No newline at end of file

locomotivecms_steam.gemspec +1 -1

@@	@@ -8,7 +8,7 @@ Gem::Specification.new do \|spec\|
	spec.description = %q{The LocomotiveCMS steam is a front end server LocomotiveCMS libraries}
	spec.summary = %q{The LocomotiveCMS steam is a technical piece for compiled and steam front end stuff for LocomotiveCMS libraries}
	spec.homepage = 'http://www.locomotivecms.com'
-	spec.homepage = 'https://github.com/joel/scoped_rolify'
+	spec.homepage = 'https://github.com/locomotivecms/steam'
	spec.license = 'MIT'

	spec.files = `git ls-files`.split($/)