Release v1.0.0 | Core Release

.github/workflows/check-eol.yml

@@ -1,5 +1,5 @@
-name: Check End-of-Line Sequence
-run-name: Check End-of-Line Sequence
+name: Check End-of-Line Sequences
+run-name: Check End-of-Line Sequences
 
 on:
   push:

README.md

@@ -1,22 +1,24 @@
-# reusable-workflow
-A reusable workflow for doing x, y, and z.
+# check-eol-composite
+A composite action for linting end-of-line sequences.
 
 ## Installation
-Add a new workflow under `.github/workflows/` with the following contents.
+Open the workflow(s) to add the composite action to, then add the step below to the desired jobs.
 ```yml
-name: New Reusable Workflow
-run-name: New Reusable Workflow
-
-on:
-  push:
-
 jobs:
-  reusable-workflow:
-    uses: Arthri/reusable-workflow/.github/workflows/reusable-workflow.yml@v1
-
+  job:
+    - name: Check End-of-Line Sequences
+      uses: Arthri/check-eol-composite@v1
 ```
 
 ## Usage
-1. Do this.
-1. Do that.
-1. This happens.
+
+### Default End-of-Line Sequence
+The workflow enforces `LF` for all files in the index. `autocrlf=true` modifies files in the working tree rather than the index and thus does not affect the composite action. The following example configures the workflow to enforce `CRLF` instead.
+```yml
+jobs:
+  job:
+    - name: Check End-of-Line Sequences
+      uses: Arthri/check-eol-composite@v1
+      with:
+        default-eol: crlf
+```

action.yml

@@ -1,6 +1,6 @@
 author: Arthri
 name: Check End-of-Line Sequences
-description: "Checks text files' end-of-line sequences."
+description: "Lints text files' end-of-line sequences."
 
 inputs:
   default-eol:

docs/Test_List.md

@@ -1,11 +1 @@
-# Test List
-A list of steps for testing the workflow's features.
-
-## Action fails randomly
-
-### Steps
-1. Push to GitHub.
-
-### Outputs
-1. Workflow triggers.
-1. Workflow fails randomly.
+See https://github.com/Arthri/check-eol/blob/master/docs/Test_List.md