add readme

1 files changed, 4 insertions, 1 deletions

diff --git a/src/Main.hs b/src/Main.hs
index 5b8b66f..be28f07 100644
--- a/src/Main.hs
+++ b/src/Main.hs
@@ -37,8 +37,11 @@ data Options = Options
   , pretty       :: Bool
   -- ^ pretty-print the json to make it human-readable
   , out          :: Maybe String
-  , config       :: Maybe (LintConfig Maybe)
+  -- ^ path to write the (possibly adjusted) maps to after linting
   , configFile   :: Maybe FilePath
+  -- ^ path to a config file. Currently required.
+  , config       :: Maybe (LintConfig Maybe)
+  -- ^ a "patch" for the configuration file
   } deriving (Show, Generic, HasArguments)