Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Installation instructions for 1.0
  • Loading branch information
athieriot committed Sep 28, 2012
1 parent ee8a37d commit 4a2bbfe
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,29 @@ About
JTaches provides a Java way to execute tasks on file events.
Mostly inspired by the [Guard](https://github.com/guard/guard/) ruby gem.

Binaries
--------

There is not yet an easy and fast way to install JTaches.
However, you can find the binary pre-compiled with all needed dependencies on the [Sonatype](http://search.maven.org/#search%7Cga%7C1%7Cjtaches) repository:
[jtaches-1.0.0-jar-with-dependencies.jar](http://search.maven.org/remotecontent?filepath=com/github/athieriot/jtaches/1.0.0/jtaches-1.0.0-jar-with-dependencies.jar)

Then you just need to execute:

java -jar jtaches-1.0.0-jar-with-dependencies.jar -h

Example of shell launcher: [https://github.com/athieriot/JTaches/blob/master/jtaches](https://github.com/athieriot/JTaches/blob/master/jtaches)

Sources
-------

Until we find a better way to deploy it, you have to compile JTaches yourself.
If you absolutely want the latest version, you will have to compile JTaches yourself.
Download the sources via git or directly: https://github.com/athieriot/JTaches/tarball/master

mvn clean install

./jtaches -h

Usage
-----

Expand Down Expand Up @@ -64,6 +77,16 @@ Hack
If you want to build a Tache, you need to write a new class implementing the Tache interface.
ConfiguredTache is just an abstract class made to ease the work.

Installation via Maven:


<dependency>
<groupId>com.github.athieriot</groupId>
<artifactId>jtaches</artifactId>
<version>1.0.0</version>
<scope>test</scope>
</dependency>

Then, you have access to five things:

+ getPath() that you need to implement to provide the path to watch.
Expand Down

0 comments on commit 4a2bbfe

Please sign in to comment.