doc

rcpoison · Dec 17, 2015 · 100ed1d · 100ed1d
1 parent ea85860
commit 100ed1d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -15,12 +15,14 @@ usage: java -jar steam-scraper-*.one-jar.jar
  -f <file>                absolute path to sharedconfig.vdf to use
  -g                       don't add genres
  -h,--help                show this help and print paths
- -i <file>                whitelist for tags to include
+ -i <file>                whitelist for tags to include (one tag per line)
  -I                       remove all existing tags not in specified
                           whitelist
  -p                       print all available tags (respects -c, -g and
                           -u)
  -r,--remove <category>   remove categories
+ -R <file>                file containing replacements (one replacement
+                          per line, in the format original=replacement)
  -u                       add user tags
  -w                       directly overwrite sharedconfig.vdf (quit steam
                           before running!)
@@ -48,6 +50,13 @@ java -jar steam-scraper-*.one-jar.jar -u -i whitelist.txt -I -w
 ```
 
 
+Replacement file example:
+```
+1990's = 1990s
+Rogue-lite = Rogue-like
+Single-player = Singleplayer
+```
+
 ## Build dependencies
 * maven 3
 * openjdk 7/8

diff --git a/src/main/java/com/ignorelist/kassandra/steam/scraper/Tagger.java b/src/main/java/com/ignorelist/kassandra/steam/scraper/Tagger.java
@@ -242,9 +242,9 @@ private static Options buildOptions() {
 		options.addOption("u", false, "add user tags");
 		options.addOption("p", false, "print all available tags (respects -c, -g and -u)");
 		options.addOption(Option.builder("r").longOpt("remove").hasArgs().argName("category").desc("remove categories").build());
-		options.addOption(Option.builder("i").hasArg().argName("file").desc("whitelist for tags to include").build());
+		options.addOption(Option.builder("i").hasArg().argName("file").desc("whitelist for tags to include (one tag per line)").build());
 		options.addOption("I", false, "remove all existing tags not in specified whitelist");
-		options.addOption(Option.builder("R").hasArg().argName("file").desc("file containing replacements").build());
+		options.addOption(Option.builder("R").hasArg().argName("file").desc("file containing replacements (one replacement per line, in the format original=replacement)").build());
 		return options;
 	}