guard-shell 0.1 → 0.1.1

data/README.md

@@ -1,8 +1,29 @@
 # Guard-Shell
 
 This little addition (1 proper line of code!) to guard allows you to run shell
-commands when certain files are altered. It is very simple to setup so here is
-a very quick guide.
+commands when certain files are altered.
+
+
+## Install
+  
+Make sure you have [guard](http://github.com/guard/guard) installed.
+
+Install the gem with:
+
+    gem install guard-shell
+
+Add it to your Gemfile:
+
+    guard 'guard-shell'
+
+And then add a basic setup to your Guardfile:
+
+    guard init shell
+
+
+## Usage
+
+If you can do something in your shell, it is probably very easy to setup with guard-shell, here are a few examples.
 
 
 #### Creating Backups of Files On Change
@@ -13,11 +34,21 @@ a very quick guide.
     end
 
 
-#### Rebuilding a Latex File
+#### Showing git st
+
+    guard 'shell' do
+      watch('.*') { `git st` }
+    end
+
+
+#### Rebuilding a LaTeX File
 
     guard 'shell' do
       # builds latex file to pdf and hides output
-      watch('(.*).tex') {|m| `pdflatex -shell-escape #{m[0]} 1>/dev/null` }
+      watch('(.*).tex') do |m| 
+        `pdflatex -shell-escape #{m[0]} 1>/dev/null`
+        puts "built #{m[1]}.pdf"
+      end
     end
 
 
@@ -26,6 +57,3 @@ a very quick guide.
     guard 'shell' do
       watch('(.*)') {|m| `say #{m[0]}` }
     end
-    
-
-And pretty much anything else you can think of!

data/lib/guard/shell.rb

@@ -4,7 +4,7 @@ require 'guard/guard'
 module Guard
   class Shell < Guard
   
-    VERSION = '0.1'
+    VERSION = '0.1.1'
 
     # Print the result of the command, if there is a result
     # to be printed. (see README.md)

metadata

@@ -5,7 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  version: "0.1"
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Joshua Hawxwell
@@ -13,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-17 00:00:00 +01:00
+date: 2010-10-27 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,13 +22,13 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 1
+        - 2
         - 0
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: *id001
@@ -62,7 +63,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id003
-description: Guard::Shell automatically run shell commands when watched files are modified.
+description: Guard::Shell automatically runs shell commands when watched files are modified.
 email: 
 - m@hawx.me
 executables: []