Permalink
Browse files

Misc project setup and basic documentation.

  • Loading branch information...
Darrick Wiebe
Darrick Wiebe committed Mar 30, 2011
1 parent ed4b4ff commit 70265c4cd57733babb68ebcb3a1da0f75a535038
Showing with 31 additions and 13 deletions.
  1. +1 −3 Gemfile
  2. +14 −4 README.rdoc → README.md
  3. +4 −6 Rakefile
  4. +1 −0 VERSION
  5. +11 −0 lib/pacer-agent.rb
View
@@ -1,7 +1,5 @@
source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-# gem "activesupport", ">= 2.3.5"
+gem 'pacer', '>= 0.6.0'
# Add dependencies to develop your gem here.
# Include everything needed to run rake, tests, features, etc.
View
@@ -1,8 +1,18 @@
-= pacer-agent
+# Agent plugin for Pacer (pacer-agent)
-Description goes here.
+This plugin adds the concurrency features from [Agent](https://github.com/igrigorik/agent) to [Pacer](https://github.cob/pangloss/pacer).
-== Contributing to pacer-agent
+For more information on Agent, check out this great blog post on
+[Concurrency with Actors, Goroutines & Ruby](http://www.igvita.com/2010/12/02/concurrency-with-actors-goroutines-ruby/).
+
+## Project status
+
+This is currently more of a proof of concept or spike than an actual
+production-ready implementation. Only TinkerGraph elements are actually
+serializable right now so, so using this with other element types will
+probably work rather poorly.
+
+## Contributing to pacer-agent
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -12,7 +22,7 @@ Description goes here.
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-== Copyright
+## Copyright
Copyright (c) 2011 Darrick Wiebe. See LICENSE.txt for
further details.
View
@@ -15,14 +15,12 @@ Jeweler::Tasks.new do |gem|
gem.name = "pacer-agent"
gem.homepage = "http://github.com/pangloss/pacer-agent"
gem.license = "MIT"
- gem.summary = %Q{TODO: one-line summary of your gem}
- gem.description = %Q{TODO: longer description of your gem}
+ gem.summary = %Q{Use a Go-like concurrency strategy with Pacer}
+ gem.description = %Q{Allows elements from a route to be pushed though a channel and then routed further.}
gem.email = "darrick@innatesoftware.com"
gem.authors = ["Darrick Wiebe"]
- # Include your dependencies below. Runtime dependencies are required when using your gem,
- # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
- # gem.add_runtime_dependency 'jabber4r', '> 0.1'
- # gem.add_development_dependency 'rspec', '> 1.2.3'
+ gem.add_runtime_dependency 'agent', '0.1'
+ gem.add_development_dependency 'rspec', '> 1.2.3'
end
Jeweler::RubygemsDotOrgTasks.new
View
@@ -0,0 +1 @@
+0.1.0
View
@@ -1,5 +1,16 @@
require 'agent'
+module PacerAgent
+ unless const_defined? :VERSION
+ PATH = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+ VERSION = File.read(PATH + '/VERSION').chomp
+ end
+
+ def self.reload!
+ load __FILE__
+ end
+end
+
module Pacer
module Core
module Route

0 comments on commit 70265c4

Please sign in to comment.