align with latest version

added -skip option to ignore input lines with issues
namsor · Nov 1, 2020 · 34fa47e · 34fa47e
1 parent e9320be
commit 34fa47e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -1,24 +1,21 @@
 # namsor-tools-v2
-NamSor command line tools, to append gender, origin, diaspora or us 'race'/ethnicity to a CSV file.
+NamSor command line tools, to append gender, origin, diaspora or us 'race'/ethnicity to a CSV file. The CSV file should in UTF-8 encoding, pipe-| demimited. It can be very large. 
 
 ## Installation
 
-Please install https://github.com/namsor/namsor-java-sdk2 first, then use Maven to build the executable JAR file
-
+Please install Maven first, then build the executable with command
 ```bash
-mvn package
+mvn clean package
 ```
 NB: we use Unix conventions for file paths, ex. samples/some_fnln.txt but on MS Windows that would be samples\some_fnln.txt
 
 ## Usage
 
 ```bash
-java -jar target/NamSorToolsV2-1.0-SNAPSHOT.jar
-
 usage: NamSorTools -apiKey <apiKey> [-basePath <basePath>] [-countryIso2
        <countryIso2>] [-digest] [-e <encoding>] -f <inputDataFormat> [-h]
-       [-header] -i <inputFile> [-o <outputFile>] [-r] -service <service>
-       [-uid] [-w]
+       [-header] -i <inputFile> [-o <outputFile>] [-r] [-s] -service
+       <service> [-uid] [-w]
  -apiKey,--apiKey <apiKey>                  NamSor API Key
  -basePath,--basePath <basePath>            Base Path, ex.
                                             https://v2.namsor.com/NamSorAP
@@ -38,6 +35,7 @@ usage: NamSorTools -apiKey <apiKey> [-basePath <basePath>] [-countryIso2
  -o,--outputFile <outputFile>               output file name
  -r,--recover                               continue from a job (requires
                                             uid)
+ -s,--skip                                  skip errors
  -service,--endpoint <service>              service : parse / gender /
                                             origin / country / diaspora /
                                             usraceethnicity
@@ -93,5 +91,5 @@ https://github.com/namsor/namsor-tools-v2/wiki/NamSor-Tools-V2
 ## Contributing
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
-Please make sure to update tests as appropriate.
+
 
diff --git a/pom.xml b/pom.xml
@@ -14,7 +14,7 @@
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>namsor-sdk2</artifactId>
-            <version>2.0.10</version>
+            <version>2.0.11</version>
         </dependency>
     </dependencies>
     <build>