Update README

huacnlee · Jul 19, 2021 · 828c3b1 · 828c3b1
1 parent b71f12e
commit 828c3b1
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,14 @@
 # autocorrect-action
-GitHub action for use AutoCorrect as lint
+
+GitHub Action to use [AutoCorrect](https://github.com/huacnlee/autocorrect) for lint.
+
+https://github.com/huacnlee/autocorrect
+
+```yml
+steps:
+  - name: Check source code
+    uses: actions/checkout@master
+
+  - name: Install Rust
+    uses: huacnlee/autocorrect-action@master
+```