jcapote-atomlog 1.0.2 → 1.0.3

data/README.markdown

@@ -2,50 +2,58 @@
 
 AtomLog is a library for converting ruby's Logger format into an Atom feed
 
-## Gem Dependencies
+## Installation
 
-   Builder
+Add the github gem source if you haven't already:
+    
+    gem sources -a http://gems.github.com
+    
+Install the gem:
 
-   UUID
+    gem install jcapote-atomlog
 
-   file-tail   
+## Usage
 
-## Installation
+### From within your applications:
 
-	gem install builder
-	gem install uuid
-	gem install file-tail
-	git clone git@github.com:jcapote/atomlog.git
+Basic usage:
 
-## Usage
+    require 'atom_log'
+    a = AtomLog::Generator.new('path/to/log.log')
+    a.to_atom #=> feed as a string
+
+For large or rapidly growing log files, it's useful only to see the last 10 or so events; To achieve this, just pass how many lines back you want to go to the generator constructor as the 2nd argument:
 
-It comes with a standalone tool, bin/log2atom.rb; use as such:
+    require 'atom_log'
+    a = AtomLog::Generator.new('path/to/log.log', 100)
+    a.to_atom #=> feed as a string
 
-   bin/log2atom.rb logger-file.log
+Or if you want to parse the log file into your own format (sql, json, etc), you can use the parser directly (this also takes the lines desired as the 2nd argument):
 
-You can also use it from within your applications (it's intended purpose) by adding atomlog
-to your application's load path:
+    require 'atom_log'
+    a = AtomLog::Parser.new('path/to/log.log', 100)
+    a.parse #=> array of log fields
 
-      require 'atom_log'
-      a = AtomLog::Generator.new('path/to/log.log')
-      a.to_atom
+### From the shell:
 
-For large or rapidly growing log files, sometimes it's useful only to see the last 10 or so events; To achieve this, just pass how many lines back you want to go to the generator constructor as the 2nd argument:
+It comes with a standalone tool, log2atom; use as such:
 
-      require 'atom_log'
-      a = AtomLog::Generator.new('path/to/log.log', 100)
-      a.to_atom
+    log2atom logger-file.log
 
 
 ## Performance
 
 Out of curiousity, I decided to benchmark reading a 4.4mb log file against all the ruby implementations on my machine, here are the results:
 
-        ruby 1.8.6 (2007-09-24 patchlevel 111) [universal-darwin9.0]: 53s
-        ruby 1.9.1p0 (2009-01-30 revision 21907) [i386-darwin9.2.0]: 30s *FASTEST*
-        jruby 1.1.6RC1 (ruby 1.8.6 patchlevel 114) (2008-12-03 rev 8263) [i386-java]: 46s
-        jruby --server 1.1.6RC1 (ruby 1.8.6 patchlevel 114) (2008-12-03 rev 8263) [i386-java]: 34s   
-	
+
+    30s: ruby 1.9.1p0 (2009-01-30 revision 21907) [i386-darwin9.2.0]
+
+    34s: jruby --server 1.1.6RC1 (ruby 1.8.6 patchlevel 114) (2008-12-03 rev 8263) [i386-java]
+
+    46s: jruby 1.1.6RC1 (ruby 1.8.6 patchlevel 114) (2008-12-03 rev 8263) [i386-java]
+
+    53s: ruby 1.8.6 (2007-09-24 patchlevel 111) [universal-darwin9.0]
+
 
 ## License and Author
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 0
-:patch: 2
 :major: 1
+:minor: 0
+:patch: 3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jcapote-atomlog
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors: 
 - jcapote
@@ -11,8 +11,37 @@ cert_chain: []
 
 date: 2009-02-26 00:00:00 -08:00
 default_executable: log2atom
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: uuid
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: file-tail
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: A library for parsing ruby's Logger format into an Atom feed
 email: jcapote@gmail.com
 executables: