Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
walle committed May 5, 2011
1 parent 3c01c97 commit 57a8963
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions README.textile
Expand Up @@ -4,40 +4,41 @@ gimli guard allows to automatically convert your files when markup is changed

h2. Install

Please be sure to have {Guard}[http://github.com/guard/guard] installed before continue.
Please be sure to have "Guard":http://github.com/guard/guard installed before continue.

Install the gem:

gem install guard-gimli
bc. gem install guard-gimli

Add guard definition to your Guardfile by running this command:

guard init gimli
bc. guard init gimli

h2. Usage

Please read {Guard usage doc}[http://github.com/guard/guard#readme] and {gimli usage doc}[http://github.com/walle/gimli#readme]
All commands originate from the directory where the file is located
Please read "Guard usage doc":http://github.com/guard/guard#readme and "gimli usage doc":http://github.com/walle/gimli#readme

h2. Guardfile

You can adapt your markup files like you want.
Please read {Guard doc}[http://github.com/guard/guard#readme] for more info about Guardfile DSL.
Please read "Guard doc":http://github.com/guard/guard#readme for more info about Guardfile DSL.

guard 'gimli' do
watch(%r{.+\.(md|mkdn?|mdown|markdown|textile|rdoc|org|creole|re?st(\.txt)?|asciidoc|pod|\d|(media)?wiki)})
end
bc. guard 'gimli' do
watch(%r{.+\.(md|mkdn?|mdown|markdown|textile|rdoc|org|creole|re?st(\.txt)?|asciidoc|pod|\d|(media)?wiki)})
end

h2. Options

LiveReload guard have 1 option that you can set like this:

This comment has been minimized.

Copy link
@svendahlstrand

svendahlstrand May 5, 2011

LiveReload? :) För övrigt mycket tufft plugin!

This comment has been minimized.

Copy link
@walle

walle May 5, 2011

Author Owner

Japp, lånade den strukturen ;)
Men nu är det fixat iaf.
Ja, jag är alldeles för bra på att skjuta upp arbetet. Nu har jag gjort tre gems för att underlätta det, men har inte jobbat på det :D


guard 'gimli', :outputdir => 'build' do
...
end
bc. guard 'gimli', :outputdir => 'build' do
...
end

Available options:

:outputdir => 'build' # default nil ie. working dir
bc. :outputdir => 'build' # default nil ie. directory of file

See {gimli doc}[http://github.com/walle/gimli#readme] for more info.
See "gimli doc":http://github.com/walle/gimli#readme for more info.

0 comments on commit 57a8963

Please sign in to comment.