Documentation

README.md

@@ -4,8 +4,6 @@ A Git subcommand to show total addition, deletion per file
 
 ## Installation
 
-Please note: not yet released. Just a future plan.
-
 ```
 $ cabal install git-freq
 ```
@@ -44,4 +42,8 @@ cabal configure --enable-tests && cabal build && cabal test
 
 ## Contributing
 
-TODO: Write contribution instructions here
+- Fork it
+- Create your feature branch (git checkout -b my-new-feature)
+- Commit your changes (git commit -am 'Add some feature')
+- Push to the branch (git push origin my-new-feature)
+- Create new Pull Request

src/Main.hs

@@ -16,6 +16,7 @@ config = Config
       (long "version" <> short 'v' <> help "Show version")
   <*> many
       (argument str (metavar "PATH..." <> help "Target paths"))
+
 main :: IO ()
 main = do
     (Config showVersion paths) <- execParser opts
@@ -24,5 +25,8 @@ main = do
   where
     opts = info (helper <*> config)
       ( fullDesc
-     -- <> progDesc "Show frequently changed code in the repository"
+      <> progDesc (unlines [ "Total addition, deletion per file will be shown as a csv in following format:"
+                            , "`file name, addition, deletion`"
+                            ])
+
      <> header "git-freq - Show frequently changed code in the repository")