From 71c9ff02f2a10594cfd1a29c50c33af5d2658d2b Mon Sep 17 00:00:00 2001
From: Fionn Fitzmaurice <fionn@github.com>
Date: Mon, 1 Apr 2024 03:44:58 +0800
Subject: [PATCH] Add documentation

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f788e20
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Newline Linter
+
+> **3.206 Line**
+> A sequence of zero or more non- <newline> characters plus a terminating <newline> character.
+
+## GitHub Action
+
+### Inputs
+
+* `exclusion_pattern`
+    * Optional extended-`grep`-compatible pattern of filenames to exclude.
+
+### Example
+
+```yml
+- name: Lint newlines
+  uses: fionn/newline-linter@master
+  with:
+    exclusion_pattern: not_text.jpeg
+```
+
+## Git Subcommand
+
+Install `git-no-newline` in your path and run
+```shell
+$ git no-newline
+```
+in a Git repository to list non-binary files that do not terminate in a newline.