Permalink
Browse files

added quartz-jruby.rdoc for hoe to build the gem

  • Loading branch information...
1 parent 302353a commit 6986e32554be8164c67c57fa3e850768ec9fc8da @vagmi vagmi committed Dec 2, 2010
Showing with 110 additions and 11 deletions.
  1. +19 −10 LICENSE
  2. +22 −1 README.markdown
  3. +1 −0 Rakefile
  4. +68 −0 quartz-jruby.rdoc
View
29 LICENSE
@@ -1,11 +1,20 @@
-Copyright (c) 2010 Vagmi Mudumbai
+Copyright (c) 2010, Vagmi Mudumbai
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
-Unless required by applicable law or agreed to in writing, software distributed under
-the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
-either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
23 README.markdown
@@ -18,4 +18,25 @@ From [Quartz Scheduler's website](http://www.quartz-scheduler.org/)
If you have any feedback, send me an email vagmi <at> [artha42.com](http://www.artha42.com).
-
+## License
+
+Copyright (c) 2010, Vagmi Mudumbai
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
1 Rakefile
@@ -11,6 +11,7 @@ Hoe.plugin :newgem
# Generate all the Rake tasks
# Run 'rake -T' to see list of generated tasks (from gem root directory)
$hoe = Hoe.spec 'quartz-jruby' do
+ self.readme_file = 'quartz-jruby.rdoc'
self.version = Quartz::VERSION
self.developer 'Vagmi Mudumbai', 'vagmi@artha42.com'
self.rubyforge_name = self.name # TODO this is default value
View
68 quartz-jruby.rdoc
@@ -0,0 +1,68 @@
+= Quartz JRuby
+
+* http://github.com/artha42/quartz-jruby
+
+== DESCRIPTION:
+
+From {Quartz Scheduler's website}[http://www.quartz-scheduler.org/]
+
+Quartz is a full-featured, open source job scheduling service that can be integrated with, or used along side virtually any Java EE or Java SE application - from the smallest stand-alone application to the largest e-commerce system. Quartz can be used to create simple or complex schedules for executing tens, hundreds, or even tens-of-thousands of jobs; jobs whose tasks are defined as standard Java components that may executed virtually anything you may program them to do. The Quartz Scheduler includes many enterprise-class features, such as JTA transactions and clustering.
+
+This gem makes these available in a ruby friendly syntax
+
+== FEATURES/PROBLEMS:
+
+* Currently none known
+
+== SYNOPSIS:
+
+ <tt>
+ class TestScheduler
+ include Quartz::Scheduler
+ schedule(:say_hello_5, :every=>5.seconds) { info "every 5 seconds" }
+ schedule(:say_hello_30, :every=>30.seconds) { error "every 30 seconds" }
+ end
+ TestScheduler.instance.run
+ </tt>
+
+== REQUIREMENTS:
+
+* Requires JRuby 1.5.x and ActiveSupport 3.0.3
+
+== INSTALL:
+
+* gem install quartz-jruby
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+ $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010, Vagmi Mudumbai
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 comments on commit 6986e32

Please sign in to comment.