From 8fe064d0bd7ed0fbb665774f1aa77845ed56c99b Mon Sep 17 00:00:00 2001
From: Nuz / Lovegood <nuztalgia@gmail.com>
Date: Sat, 8 Oct 2022 10:58:42 -0700
Subject: [PATCH] Alphabetize & clarify `file-contents-sorter` in README

---
 README.md | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 1026d3f..27dae97 100644
--- a/README.md
+++ b/README.md
@@ -114,6 +114,17 @@ This hook replaces double quoted strings with single quoted strings.
 #### `end-of-file-fixer`
 Makes sure files end in a newline and only a newline.
 
+#### `file-contents-sorter`
+Sort the lines in specified files (defaults to alphabetical).
+You must provide the target [`files`](https://pre-commit.com/#config-files) as input, for example:
+
+```yaml
+    -   id: file-contents-sorter
+        files: \.gitignore
+```
+
+Note that this hook WILL remove blank lines and does NOT respect any comments.
+
 #### `fix-byte-order-marker`
 removes UTF-8 byte order marker
 
@@ -121,11 +132,6 @@ removes UTF-8 byte order marker
 Add `# -*- coding: utf-8 -*-` to the top of python files.
   - To remove the coding pragma pass `--remove` (useful in a python3-only codebase)
 
-#### `file-contents-sorter`
-Sort the lines in specified files (defaults to alphabetical).
-You must provide list of target files as input to it.
-Note that this hook WILL remove blank lines and does NOT respect any comments.
-
 The following arguments are available:
 - `--ignore-case` - fold lower case to upper case characters.
 - `--unique` - ensure each line is unique.