Update README

README.md

@@ -1,12 +1,65 @@
-This is a copy of upstream's [jnotify](http://jnotify.sourceforge.net).
+JNotify
+=======
 
-CVS sucks, so I'm taking a snapshot (version 0.94) and building from there.
-Since there's been like one patch in the past three years, I'm not really
-worried about diverging much from upstream.
+JNotify is a Java library that allow applications to listen to filesystem
+events, such as:
 
-To build:
+ - File created
+ - File modified
+ - File renamed
+ - File deleted
 
-    ant build build_libraries
+This repository is a fork of upstream's [jnotify](http://jnotify.sourceforge.net).
+
+The last upstream release was 0.94, back in April 2012, and the original source repository
+was on CVS, which is frankly awful to work with, hence the creation of this fork.
+
+## Noteworthy changes
+
+This fork is *not* a drop-in replacement.
+
+To make the best out of each platform-specific API, the simplified platform-agnostic
+abstraction layer was dropped to ease maintenance.
+
+The name of the native libraries was changed to reflect the incompatibility.
+
+## Build native code
+
+You need `qmake` which is part of [Qt](https://www.qt.io) (4 or 5).
+
+```
+qmake && make
+```
+
+Note that this does *not* cross-compile, so you need to run this command on every supported
+platform you want to build native code for (Linux, macOS, Windows).
+
+Build output can be removed with `make clean` or `make distclean`
+
+## Build JAR
+
+The following command will build the main jar (no sources or javadocs) and place it in `build/libs`
+
+```
+gradle jar
+```
+
+## Deploy to Nexus/Maven
+
+To deploy to a private Nexus repository, simply create a `gradle.properties` file with the
+following variables:
+
+```
+nexusRepo=http://repo.domain.tld
+nexusUser=user
+nexusPass=password
+```
+
+Then run the following command to deploy all jars (main, sources, javadoc) to that repo
+
+```
+gradle uploadArchives
+```
+
+NB: Native code is *not* deployed to the repo and needs to be bundled separately in your application.
 
-Your binaries are now in <code>build/</code>.  To clean, either <code>ant clean</code>
-or just <code>rm -rf build</code> and run the above command again.