Please add usage instructions for repominer

[eric-optimizely]

Instructions for how to use repominer.py are noticeably absent from the README file, which focuses mostly on using repoguard.py. It'd be great if documentation for using repominer could be added as well.

[kepten]

Hi Eric,
Thanks for the issues! If you run repominer without any arguments, you should get a help output similar to this:

(virtualenv)➜  repoguard git:(master) ✗ python repominer.py
No files given.
usage: repominer.py [-h] [--rule-dir RULE_DIR] [--alerts ALERTS]
                    [--store STORE]
                    [file [file ...]]

Check a sourcecode repo

positional arguments:
  file                  Files to check

optional arguments:
  -h, --help            show this help message and exit
  --rule-dir RULE_DIR   Directory of rules
  --alerts ALERTS, -a ALERTS
                        Limit running only the given alert checks (comma
                        separated list)
  --store STORE, -S STORE
                        ElasticSearch node (host:port)

You are right that it should be in the README as well, so far it wasn't important for anyone to fix this. If you feel the urgency, we are happy to review pull requests! :)