Update README and add CHANGELOG

[ci skip]

Author: andreasabel

CHANGELOG.md

@@ -0,0 +1,8 @@
+# fix-whitespace
+
+Version history.
+
+## 0.0.5 released 2021-03-11
+
+- initial release
+- tested with GHC 8.0.2 - 9.0.1

README.md

@@ -1,32 +1,44 @@
-fix-whitespace: Fixes whitespace issues. [![Build Status](https://travis-ci.org/agda/fix-whitespace.svg?branch=master)](https://travis-ci.org/agda/fix-whitespace)
----------------------------------------------
+fix-whitespace: Fixes whitespace issues
+=======================================
+
+[![Hackage version](https://img.shields.io/hackage/v/fix-whitespace.svg?label=Hackage)](http://hackage.haskell.org/package/fix-whitespace)
+[![Hackage CI](https://matrix.hackage.haskell.org/api/v2/packages/fix-whitespace/badge)](https://matrix.hackage.haskell.org/package/fix-whitespace)
+[![fix-whitespace on Stackage Nightly](https://stackage.org/package/fix-whitespace/badge/nightly)](https://stackage.org/nightly/package/fix-whitespace)
+[![Stackage LTS version](https://www.stackage.org/package/fix-whitespace/badge/lts?label=Stackage)](https://www.stackage.org/package/fix-whitespace)
+[![Build status](https://github.com/agda/fix-whitespace/workflows/Build%20by%20Stack/badge.svg)](https://github.com/agda/fix-whitespace/actions)
+
+
+This tool can keep your project and repository clean of trailing
+whitespace and missing terminal newline.
 
 Usage: `fix-whitespace [-h|--help] [-v|--verbose] [--check] [--config CONFIG] [FILES]`
 
-The program does the following
+The program does the following to files specified in `FILES` or in the
+configuration file `fix-whitespace.yaml` under the current directory
+(and its subdirectories):
 
-* Removes trailing whitespace.
-* Removes trailing lines containing nothing but whitespace.
-* Ensures that the file ends in a newline character.
+  * Remove trailing whitespace.
+  * Remove trailing lines containing nothing but whitespace.
+  * Ensure that the file ends in a newline character.
 
-for files specified in `[FILES]` or
+Available options:
 
-        fix-whitespace.yaml
+*  `-h  --help`
 
-under the current directory.
+   Show this help information.
 
-Background: Agda was reported to fail to compile on Windows
-because a file did not end with a newline character (Agda
-uses `-Werror`).
+*  `-v  --verbose`
 
-Available options:
+   Show files as they are being checked.
+
+*  `--config=CONFIG`
 
-*  `-h  --help`           Show this help information.
+   Override the project configuration `fix-whitespace.yaml`.
 
-*  `-v  --verbose`        Show files as they are being checked.
+*  `--check`
 
-*  `--config=CONFIG`  Override the project configuration `fix-whitespace.yaml`.
+   With `--check` the program does not change any files,
+   it just checks if any files would have been changed.
+   In this case it returns with a non-zero exit code.
 
-*  `--check`          With `--check` the program does not change any files,
-                       it just checks if any files would have been changed.
-                       In this case it returns with a non-zero exit code.
+For an example configuration file see [the one of Agda](https://github.com/agda/agda/blob/f9a181685397517b5d14943ca88a1c0acacc2075/fix-whitespace.yaml).

fix-whitespace.cabal

@@ -20,6 +20,10 @@ tested-with:     GHC == 8.0.2
                  GHC == 8.10.4
                  GHC == 9.0.1
 
+extra-source-files:
+  CHANGELOG.md
+  README.md
+
 source-repository head
   type: git
   location: https://github.com/agda/fix-whitespace.git