Permalink
Browse files

modified license and added history and more documentation

  • Loading branch information...
calavera committed Apr 17, 2010
1 parent a60709e commit acc0410dcc0791e5b6092713ea28f0ad3fa12f58
Showing with 54 additions and 19 deletions.
  1. +3 −0 History.txt
  2. +17 −18 LICENSE
  3. +33 −1 README
  4. +1 −0 trinidad_daemon_extension.gemspec
View
@@ -0,0 +1,3 @@
+0.1.0 (2010-04-17)
+
+ * First release
View
35 LICENSE
@@ -1,21 +1,20 @@
-The MIT License
+Copyright (c) 2009 David Calavera
-Copyright (c) Tom Preston-Werner
+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:
-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 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.
+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
34 README
@@ -5,6 +5,38 @@ Trinidad Daemon Extension
Extension to run Trinidad server as a daemon.
+[WARNING] This extension only works with Trinidad 0.8.3 or above.
+
# INSTALLATION
-Still in development
+jruby -S gem install trinidad_daemon_extension
+
+# USAGE
+
+This extension can be enabled from the Trinidad's configuration file or from the command line.
+It uses a temporal directory to write the pid file but its route can be overrided.
+
+ * To enable it from the configuration file you have to add a section "extensions" to the root of the file and the section "daemon" to this one. The pid file can be specified there:
+
+ --
+ extensions:
+ daemon:
+ pid_file: ./trinidad.pid # this is optional by default the extension writes the pid file into a temporal directory.
+
+ * To enable it from the command line you have to load the extension first and the add one of these options:
+
+ -d, --daemonize [PID_FILE]
+
+ for instance:
+
+ $ jruby -S trinidad --load daemon --daemonize ./trinidad.pid
+
+# TODO
+
+ * enable logging. Right now the Tomcat's log is not written anywhere.
+
+You can find further information on how to write your onw extension in the wiki: http://wiki.github.com/calavera/trinidad/extensions
+
+# Copyright
+
+Copyright (c) 2010 David Calavera. See LICENSE for details.
@@ -52,6 +52,7 @@ Gem::Specification.new do |s|
## THE MANIFEST COMMENTS, they are used as delimiters by the task.
# = MANIFEST =
s.files = %w[
+ History.txt
LICENSE
README
Rakefile

0 comments on commit acc0410

Please sign in to comment.