From 4a2bbfe13890a02c77726ccf46428e36467879d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien=20Thieriot?= Date: Fri, 28 Sep 2012 10:36:36 +0300 Subject: [PATCH] Update README.md Installation instructions for 1.0 --- README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4e4c1e7..c96aedd 100644 --- a/README.md +++ b/README.md @@ -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 ----- @@ -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: + + + + com.github.athieriot + jtaches + 1.0.0 + test + + Then, you have access to five things: + getPath() that you need to implement to provide the path to watch.