From f7295025bc93d13be12b2aa6862efc6a1a672031 Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Tue, 11 Jun 2019 07:57:40 +0100 Subject: [PATCH] [readme] updated --- README.org | 34 ++++++++-------------------------- 1 file changed, 8 insertions(+), 26 deletions(-) diff --git a/README.org b/README.org index 910bef7..249e633 100644 --- a/README.org +++ b/README.org @@ -14,13 +14,16 @@ hash of the file contents. s3thorp Usage: s3thorp [options] - -s, --source Source directory to sync to S3 - -b, --bucket S3 bucket name - -p, --prefix Prefix within the S3 Bucket - -x, --exclude [,] Exclude matching paths - -v, --verbose Verbosity level (1-5) + -s, --source Source directory to sync to S3 + -b, --bucket S3 bucket name + -p, --prefix Prefix within the S3 Bucket + -i, --include Include matching paths + -x, --exclude Exclude matching paths + -v, --verbose Verbosity level (1-5) #+end_example +The ~--include~ and ~--exclude~ parameters can be used more than once. + * Behaviour When considering a local file, the following table governs what should happen: @@ -35,24 +38,3 @@ When considering a local file, the following table governs what should happen: | 5 | exists | exists | no match | no matches | upload | | 6 | is missing | exists | - | - | delete | |---+------------+------------+------------------+--------------------+---------------------| - -* Creating Native Images - -Note: the created image currently can't be run outside of the base of -the project. See [[https://github.com/kemitix/s3thorp/issues/15][Issue #15]] - - - Download and install GraalVM - - https://github.com/oracle/graal/releases - - Install ~native-image~ using the graal updater - #+begin_example bash - gu install native-image - #+end_example - - Create native image - #+begin_example bash - native-image -cp `sbt 'export runtime:fullClasspath'|tail -n 1` \ - -H:Name=s3thorp \ - -H:Class=net.kemitix.s3thorp.Main \ - --allow-incomplete-classpath \ - --force-fallback - #+end_example - - Resulting file requires a JDK for execution