From 3bd6a9ff50f24bf943c4b1a6e4cb39aa2313aa6d Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sun, 13 Dec 2009 15:00:32 -0800 Subject: [PATCH] doc: we can run standalone as a client library, too --- README | 7 +++++-- Rakefile | 2 +- sunshowers.gemspec | 4 ++-- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README b/README index efb7b62..461a5ab 100644 --- a/README +++ b/README @@ -1,9 +1,10 @@ -= Sunshowers: Web Sockets for Rack+Rainbows! += Sunshowers: Web Sockets for Ruby, Rack+Rainbows! Sunshowers is a Ruby library for Web Sockets. It exposes an easy-to-use API that may be used in both clients and servers. On the server side, it is designed to work with Rack::Request and Rainbows! concurrency -models that expose a synchronous application flow. +models that expose a synchronous application flow. On the client side, +it may be used as a standalone wrapper for IO-like objects. It appears works well with the echo_client.py example shipped with pywebsocket. It has not been tested against normal web browsers, though @@ -73,6 +74,8 @@ open it up and include it: include Sunshowers::WebSocket end +See the examples/ directory in the source tree for a client example. + == Disclaimer There is NO WARRANTY whatsoever if anything goes wrong, but let us know diff --git a/Rakefile b/Rakefile index 75ac393..ffce597 100644 --- a/Rakefile +++ b/Rakefile @@ -34,7 +34,7 @@ task :news_atom do feed :xmlns => "http://www.w3.org/2005/Atom" do id! "http://rainbows.rubyforge.org/sunshowers/NEWS.atom.xml" title "Sunshowers news" - subtitle "Web Sockets for Rack+Rainbows!" + subtitle "Web Sockets for Ruby, Rack+Rainbows!" link! :rel => 'alternate', :type => 'text/html', :href => 'http://rainbows.rubyforge.org/sunshowers/NEWS.html' updated(new_tags.empty? ? "1970-01-01T00:00:00Z" : new_tags.first[:time]) diff --git a/sunshowers.gemspec b/sunshowers.gemspec index ea8531b..4f30ae0 100644 --- a/sunshowers.gemspec +++ b/sunshowers.gemspec @@ -33,7 +33,7 @@ Gem::Specification.new do |s| s.files = manifest s.homepage = %q{http://rainbows.rubyforge.org/sunshowers/} - s.summary = %q{Web Sockets for Rack+Rainbows!} + s.summary = %q{Web Sockets for Ruby, Rack+Rainbows!} s.rdoc_options = [ "-Na", "-t", "Sunshowers - #{s.summary}" ] s.require_paths = %w(lib) s.rubyforge_project = %q{rainbows} @@ -52,7 +52,7 @@ Gem::Specification.new do |s| # async_sinatra + sinatra + eventmachine # recommended: # Ruby 1.9 + FiberSpawn concurrency model with Rainbows! - s.add_dependency(%q, ["~> 0.9.0"]) + # s.add_dependency(%q, ["~> 0.9.0"]) # s.licenses = %w(GPLv2 Ruby) # accessor not compatible with older RubyGems end -- 2.11.4.GIT