Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fionn committed Mar 31, 2024
1 parent 28e2d40 commit 71c9ff0
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 71c9ff0

Please sign in to comment.